AWS.Tools.LaunchWizard.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.LaunchWizard</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZDeploymentCmdlet"> <summary> Returns information about the deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZDeploymentCmdlet.DeploymentId"> <summary> <para> <para>The ID of the deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZDeploymentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Deployment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LaunchWizard.Model.GetDeploymentResponse). Specifying the name of a property of type Amazon.LaunchWizard.Model.GetDeploymentResponse 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.LWIZ.GetLWIZDeploymentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeploymentId parameter. The -PassThru parameter is deprecated, use -Select '^DeploymentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZDeploymentEventListCmdlet"> <summary> Lists the events of a deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZDeploymentEventListCmdlet.DeploymentId"> <summary> <para> <para>The ID of the deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZDeploymentEventListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZDeploymentEventListCmdlet.NextToken"> <summary> <para> <para>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZDeploymentEventListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeploymentEvents'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LaunchWizard.Model.ListDeploymentEventsResponse). Specifying the name of a property of type Amazon.LaunchWizard.Model.ListDeploymentEventsResponse 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.LWIZ.GetLWIZDeploymentEventListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeploymentId parameter. The -PassThru parameter is deprecated, use -Select '^DeploymentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZDeploymentListCmdlet"> <summary> Lists the deployments that have been created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZDeploymentListCmdlet.Filter"> <summary> <para> <para>Filters to scope the results. The following filters are supported:</para><ul><li><para><c>WORKLOAD_NAME</c></para></li><li><para><c>DEPLOYMENT_STATUS</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZDeploymentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZDeploymentListCmdlet.NextToken"> <summary> <para> <para>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZDeploymentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Deployments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LaunchWizard.Model.ListDeploymentsResponse). Specifying the name of a property of type Amazon.LaunchWizard.Model.ListDeploymentsResponse 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.LWIZ.GetLWIZWorkloadCmdlet"> <summary> Returns information about a workload. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadCmdlet.WorkloadName"> <summary> <para> <para>The name of the workload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workload'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LaunchWizard.Model.GetWorkloadResponse). Specifying the name of a property of type Amazon.LaunchWizard.Model.GetWorkloadResponse 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.LWIZ.GetLWIZWorkloadCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkloadName parameter. The -PassThru parameter is deprecated, use -Select '^WorkloadName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadDeploymentPatternListCmdlet"> <summary> Lists the workload deployment patterns. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadDeploymentPatternListCmdlet.WorkloadName"> <summary> <para> <para>The name of the workload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadDeploymentPatternListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadDeploymentPatternListCmdlet.NextToken"> <summary> <para> <para>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadDeploymentPatternListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkloadDeploymentPatterns'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LaunchWizard.Model.ListWorkloadDeploymentPatternsResponse). Specifying the name of a property of type Amazon.LaunchWizard.Model.ListWorkloadDeploymentPatternsResponse 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.LWIZ.GetLWIZWorkloadDeploymentPatternListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkloadName parameter. The -PassThru parameter is deprecated, use -Select '^WorkloadName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadListCmdlet"> <summary> Lists the workloads. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadListCmdlet.NextToken"> <summary> <para> <para>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workloads'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LaunchWizard.Model.ListWorkloadsResponse). Specifying the name of a property of type Amazon.LaunchWizard.Model.ListWorkloadsResponse 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.LWIZ.NewLWIZDeploymentCmdlet"> <summary> Creates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the <c>Clone deployment</c> action on. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.NewLWIZDeploymentCmdlet.DeploymentPatternName"> <summary> <para> <para>The name of the deployment pattern supported by a given workload. You can use the <a href="https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html"><c>ListWorkloadDeploymentPatterns</c></a> operation to discover supported values for this parameter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.NewLWIZDeploymentCmdlet.DryRun"> <summary> <para> <para>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <c>DryRunOperation</c>. Otherwise, it is <c>UnauthorizedOperation</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.NewLWIZDeploymentCmdlet.Name"> <summary> <para> <para>The name of the deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.NewLWIZDeploymentCmdlet.Specification"> <summary> <para> <para>The settings specified for the deployment. For more information on the specifications required for creating a deployment, see <a href="https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications.html">Workload specifications</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.NewLWIZDeploymentCmdlet.WorkloadName"> <summary> <para> <para>The name of the workload. You can use the <a href="https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html"><c>ListWorkloadDeploymentPatterns</c></a> operation to discover supported values for this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.NewLWIZDeploymentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeploymentId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LaunchWizard.Model.CreateDeploymentResponse). Specifying the name of a property of type Amazon.LaunchWizard.Model.CreateDeploymentResponse 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.LWIZ.NewLWIZDeploymentCmdlet.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.LWIZ.RemoveLWIZDeploymentCmdlet"> <summary> Deletes a deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.RemoveLWIZDeploymentCmdlet.DeploymentId"> <summary> <para> <para>The ID of the deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.RemoveLWIZDeploymentCmdlet.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.LaunchWizard.Model.DeleteDeploymentResponse). Specifying the name of a property of type Amazon.LaunchWizard.Model.DeleteDeploymentResponse 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.LWIZ.RemoveLWIZDeploymentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeploymentId parameter. The -PassThru parameter is deprecated, use -Select '^DeploymentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.RemoveLWIZDeploymentCmdlet.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> |