AWS.Tools.BackupGateway.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.BackupGateway</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.BUGW.AddBUGWGatewayToServerCmdlet"> <summary> Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.AddBUGWGatewayToServerCmdlet.GatewayArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gateway. Use the <c>ListGateways</c> operation to return a list of gateways for your account and Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.AddBUGWGatewayToServerCmdlet.ServerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the server that hosts your virtual machines.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.AddBUGWGatewayToServerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GatewayArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.AssociateGatewayToServerResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.AssociateGatewayToServerResponse 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.BUGW.AddBUGWGatewayToServerCmdlet.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.BUGW.AddBUGWResourceTagCmdlet"> <summary> Tag the resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.AddBUGWResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.AddBUGWResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tags to assign to the resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.AddBUGWResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceARN'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.TagResourceResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.TagResourceResponse 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.BUGW.AddBUGWResourceTagCmdlet.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.BUGW.GetBUGWBandwidthRateLimitScheduleCmdlet"> <summary> Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWBandwidthRateLimitScheduleCmdlet.GatewayArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gateway. Use the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html"><c>ListGateways</c></a> operation to return a list of gateways for your account and Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWBandwidthRateLimitScheduleCmdlet.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.BackupGateway.Model.GetBandwidthRateLimitScheduleResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.GetBandwidthRateLimitScheduleResponse 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="T:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWGatewayCmdlet"> <summary> By providing the ARN (Amazon Resource Name), this API returns the gateway. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWGatewayCmdlet.GatewayArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWGatewayCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Gateway'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.GetGatewayResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.GetGatewayResponse 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="T:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWGatewayListCmdlet"> <summary> Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).<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. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWGatewayListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of gateways to list.</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.BUGW.GetBUGWGatewayListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned resources. For example, if a request is made to return <c>MaxResults</c> number of resources, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWGatewayListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Gateways'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.ListGatewaysResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.ListGatewaysResponse 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.BUGW.GetBUGWGatewayListCmdlet.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. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWHypervisorCmdlet"> <summary> This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWHypervisorCmdlet.HypervisorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the hypervisor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWHypervisorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Hypervisor'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.GetHypervisorResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.GetHypervisorResponse 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="T:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWHypervisorListCmdlet"> <summary> Lists your hypervisors.<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. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWHypervisorListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of hypervisors to list.</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.BUGW.GetBUGWHypervisorListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned resources. For example, if a request is made to return <c>maxResults</c> number of resources, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWHypervisorListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Hypervisors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.ListHypervisorsResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.ListHypervisorsResponse 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.BUGW.GetBUGWHypervisorListCmdlet.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. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWHypervisorPropertyMappingCmdlet"> <summary> This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWHypervisorPropertyMappingCmdlet.HypervisorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the hypervisor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWHypervisorPropertyMappingCmdlet.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.BackupGateway.Model.GetHypervisorPropertyMappingsResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.GetHypervisorPropertyMappingsResponse 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="T:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWResourceTagCmdlet"> <summary> Lists the tags applied to the resource identified by its Amazon Resource Name (ARN). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource's tags to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWResourceTagCmdlet.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.BackupGateway.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.BackupGateway.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="T:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWVirtualMachineCmdlet"> <summary> By providing the ARN (Amazon Resource Name), this API returns the virtual machine. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWVirtualMachineCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the virtual machine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWVirtualMachineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VirtualMachine'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.GetVirtualMachineResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.GetVirtualMachineResponse 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="T:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWVirtualMachineListCmdlet"> <summary> Lists your virtual machines.<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. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWVirtualMachineListCmdlet.HypervisorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWVirtualMachineListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of virtual machines to list.</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.BUGW.GetBUGWVirtualMachineListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned resources. For example, if a request is made to return <c>maxResults</c> number of resources, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.GetBUGWVirtualMachineListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VirtualMachines'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.ListVirtualMachinesResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.ListVirtualMachinesResponse 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.BUGW.GetBUGWVirtualMachineListCmdlet.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. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BUGW.ImportBUGWHypervisorConfigurationCmdlet"> <summary> Connect to a hypervisor by importing its configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.ImportBUGWHypervisorConfigurationCmdlet.HypervisorHost"> <summary> <para> <para>The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.ImportBUGWHypervisorConfigurationCmdlet.KmsKeyArn"> <summary> <para> <para>The Key Management Service for the hypervisor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.ImportBUGWHypervisorConfigurationCmdlet.Name"> <summary> <para> <para>The name of the hypervisor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.ImportBUGWHypervisorConfigurationCmdlet.Password"> <summary> <para> <para>The password for the hypervisor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.ImportBUGWHypervisorConfigurationCmdlet.Tag"> <summary> <para> <para>The tags of the hypervisor configuration to import.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.ImportBUGWHypervisorConfigurationCmdlet.Username"> <summary> <para> <para>The username for the hypervisor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.ImportBUGWHypervisorConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HypervisorArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.ImportHypervisorConfigurationResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.ImportHypervisorConfigurationResponse 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.BUGW.ImportBUGWHypervisorConfigurationCmdlet.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.BUGW.NewBUGWGatewayCmdlet"> <summary> Creates a backup gateway. After you create a gateway, you can associate it with a server using the <c>AssociateGatewayToServer</c> operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.NewBUGWGatewayCmdlet.ActivationKey"> <summary> <para> <para>The activation key of the created gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.NewBUGWGatewayCmdlet.GatewayDisplayName"> <summary> <para> <para>The display name of the created gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.NewBUGWGatewayCmdlet.GatewayType"> <summary> <para> <para>The type of created gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.NewBUGWGatewayCmdlet.Tag"> <summary> <para> <para>A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.NewBUGWGatewayCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GatewayArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.CreateGatewayResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.CreateGatewayResponse 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.BUGW.NewBUGWGatewayCmdlet.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.BUGW.RemoveBUGWGatewayCmdlet"> <summary> Deletes a backup gateway. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.RemoveBUGWGatewayCmdlet.GatewayArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gateway to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.RemoveBUGWGatewayCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GatewayArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.DeleteGatewayResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.DeleteGatewayResponse 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.BUGW.RemoveBUGWGatewayCmdlet.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.BUGW.RemoveBUGWGatewayFromServerCmdlet"> <summary> Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.RemoveBUGWGatewayFromServerCmdlet.GatewayArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gateway to disassociate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.RemoveBUGWGatewayFromServerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GatewayArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.DisassociateGatewayFromServerResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.DisassociateGatewayFromServerResponse 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.BUGW.RemoveBUGWGatewayFromServerCmdlet.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.BUGW.RemoveBUGWHypervisorCmdlet"> <summary> Deletes a hypervisor. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.RemoveBUGWHypervisorCmdlet.HypervisorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the hypervisor to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.RemoveBUGWHypervisorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HypervisorArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.DeleteHypervisorResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.DeleteHypervisorResponse 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.BUGW.RemoveBUGWHypervisorCmdlet.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.BUGW.RemoveBUGWResourceTagCmdlet"> <summary> Removes tags from the resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.RemoveBUGWResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource from which to remove tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.RemoveBUGWResourceTagCmdlet.TagKey"> <summary> <para> <para>The list of tag keys specifying which tags to remove.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.RemoveBUGWResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceARN'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.UntagResourceResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.UntagResourceResponse 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.BUGW.RemoveBUGWResourceTagCmdlet.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.BUGW.StartBUGWVirtualMachinesMetadataSyncCmdlet"> <summary> This action sends a request to sync metadata across the specified virtual machines. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.StartBUGWVirtualMachinesMetadataSyncCmdlet.HypervisorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the hypervisor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.StartBUGWVirtualMachinesMetadataSyncCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HypervisorArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.StartVirtualMachinesMetadataSyncResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.StartVirtualMachinesMetadataSyncResponse 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.BUGW.StartBUGWVirtualMachinesMetadataSyncCmdlet.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.BUGW.TestBUGWHypervisorConfigurationCmdlet"> <summary> Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.TestBUGWHypervisorConfigurationCmdlet.GatewayArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.TestBUGWHypervisorConfigurationCmdlet.HypervisorHost"> <summary> <para> <para>The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.TestBUGWHypervisorConfigurationCmdlet.Password"> <summary> <para> <para>The password for the hypervisor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.TestBUGWHypervisorConfigurationCmdlet.Username"> <summary> <para> <para>The username for the hypervisor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.TestBUGWHypervisorConfigurationCmdlet.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.BackupGateway.Model.TestHypervisorConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BUGW.UpdateBUGWGatewayInformationCmdlet"> <summary> Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.UpdateBUGWGatewayInformationCmdlet.GatewayArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gateway to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.UpdateBUGWGatewayInformationCmdlet.GatewayDisplayName"> <summary> <para> <para>The updated display name of the gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.UpdateBUGWGatewayInformationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GatewayArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.UpdateGatewayInformationResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.UpdateGatewayInformationResponse 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.BUGW.UpdateBUGWGatewayInformationCmdlet.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.BUGW.UpdateBUGWGatewaySoftwareNowCmdlet"> <summary> Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. <note><para> When you make this request, you get a <c>200 OK</c> success response immediately. However, it might take some time for the update to complete. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.UpdateBUGWGatewaySoftwareNowCmdlet.GatewayArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gateway to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.UpdateBUGWGatewaySoftwareNowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GatewayArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.UpdateGatewaySoftwareNowResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.UpdateGatewaySoftwareNowResponse 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.BUGW.UpdateBUGWGatewaySoftwareNowCmdlet.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.BUGW.UpdateBUGWHypervisorCmdlet"> <summary> Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.UpdateBUGWHypervisorCmdlet.HypervisorHost"> <summary> <para> <para>The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.UpdateBUGWHypervisorCmdlet.HypervisorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the hypervisor to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.UpdateBUGWHypervisorCmdlet.LogGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the group of gateways within the requested log.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.UpdateBUGWHypervisorCmdlet.Name"> <summary> <para> <para>The updated name for the hypervisor</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.UpdateBUGWHypervisorCmdlet.Password"> <summary> <para> <para>The updated password for the hypervisor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.UpdateBUGWHypervisorCmdlet.Username"> <summary> <para> <para>The updated username for the hypervisor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.UpdateBUGWHypervisorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HypervisorArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.UpdateHypervisorResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.UpdateHypervisorResponse 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.BUGW.UpdateBUGWHypervisorCmdlet.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.BUGW.WriteBUGWBandwidthRateLimitScheduleCmdlet"> <summary> This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.WriteBUGWBandwidthRateLimitScheduleCmdlet.BandwidthRateLimitInterval"> <summary> <para> <para>An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.WriteBUGWBandwidthRateLimitScheduleCmdlet.GatewayArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gateway. Use the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html"><c>ListGateways</c></a> operation to return a list of gateways for your account and Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.WriteBUGWBandwidthRateLimitScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GatewayArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.PutBandwidthRateLimitScheduleResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.PutBandwidthRateLimitScheduleResponse 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.BUGW.WriteBUGWBandwidthRateLimitScheduleCmdlet.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.BUGW.WriteBUGWHypervisorPropertyMappingCmdlet"> <summary> This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.WriteBUGWHypervisorPropertyMappingCmdlet.HypervisorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the hypervisor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.WriteBUGWHypervisorPropertyMappingCmdlet.IamRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.WriteBUGWHypervisorPropertyMappingCmdlet.VmwareToAwsTagMapping"> <summary> <para> <para>This action requests the mappings of on-premises VMware tags to the Amazon Web Services tags.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.WriteBUGWHypervisorPropertyMappingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HypervisorArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.PutHypervisorPropertyMappingsResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.PutHypervisorPropertyMappingsResponse 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.BUGW.WriteBUGWHypervisorPropertyMappingCmdlet.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.BUGW.WriteBUGWMaintenanceStartTimeCmdlet"> <summary> Set the maintenance start time for a gateway. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.WriteBUGWMaintenanceStartTimeCmdlet.DayOfMonth"> <summary> <para> <para>The day of the month start maintenance on a gateway.</para><para>Valid values range from <c>Sunday</c> to <c>Saturday</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.WriteBUGWMaintenanceStartTimeCmdlet.DayOfWeek"> <summary> <para> <para>The day of the week to start maintenance on a gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.WriteBUGWMaintenanceStartTimeCmdlet.GatewayArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.WriteBUGWMaintenanceStartTimeCmdlet.HourOfDay"> <summary> <para> <para>The hour of the day to start maintenance on a gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.WriteBUGWMaintenanceStartTimeCmdlet.MinuteOfHour"> <summary> <para> <para>The minute of the hour to start maintenance on a gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BUGW.WriteBUGWMaintenanceStartTimeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GatewayArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BackupGateway.Model.PutMaintenanceStartTimeResponse). Specifying the name of a property of type Amazon.BackupGateway.Model.PutMaintenanceStartTimeResponse 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.BUGW.WriteBUGWMaintenanceStartTimeCmdlet.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> |