AWS.Tools.LaunchWizard.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.LaunchWizard</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.LWIZ.AddLWIZResourceTagCmdlet"> <summary> Adds the specified tags to the given resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.AddLWIZResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.AddLWIZResourceTagCmdlet.Tag"> <summary> <para> <para>One or more tags to attach to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.AddLWIZResourceTagCmdlet.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.LaunchWizard.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.AddLWIZResourceTagCmdlet.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.LWIZ.AddLWIZResourceTagCmdlet.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.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> - The name used in deployments.</para></li><li><para><c>DEPLOYMENT_STATUS</c> - <c>COMPLETED</c> | <c>CREATING</c> | <c>DELETE_IN_PROGRESS</c> | <c>DELETE_INITIATING</c> | <c>DELETE_FAILED</c> | <c>DELETED</c> | <c>FAILED</c> | <c>IN_PROGRESS</c> | <c>VALIDATING</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.GetLWIZResourceTagCmdlet"> <summary> Lists the tags associated with a specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZResourceTagCmdlet.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.LaunchWizard.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.LaunchWizard.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.LWIZ.GetLWIZResourceTagCmdlet.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="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.GetLWIZWorkloadDeploymentPatternCmdlet"> <summary> Returns details for a given workload and deployment pattern, including the available specifications. You can use the <a href="https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloads.html">ListWorkloads</a> operation to discover the available workload names and the <a href="https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html">ListWorkloadDeploymentPatterns</a> operation to discover the available deployment pattern names of a given workload. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadDeploymentPatternCmdlet.DeploymentPatternName"> <summary> <para> <para>The name of the deployment pattern.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadDeploymentPatternCmdlet.WorkloadName"> <summary> <para> <para>The name of the workload.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.GetLWIZWorkloadDeploymentPatternCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkloadDeploymentPattern'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LaunchWizard.Model.GetWorkloadDeploymentPatternResponse). Specifying the name of a property of type Amazon.LaunchWizard.Model.GetWorkloadDeploymentPatternResponse 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.GetLWIZWorkloadDeploymentPatternListCmdlet"> <summary> Lists the workload deployment patterns for a given workload name. You can use the <a href="https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloads.html">ListWorkloads</a> operation to discover the available workload names. </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 available workload names. You can use the <a href="https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html">ListWorkloadDeploymentPatterns</a> operation to discover the available deployment patterns for a given workload. </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. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see <a href="https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications-sap.html">SAP deployment specifications</a>. To retrieve the specifications required to create a deployment for other workloads, use the <a href="https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_GetWorkloadDeploymentPattern.html"><c>GetWorkloadDeploymentPattern</c></a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.NewLWIZDeploymentCmdlet.Tag"> <summary> <para> <para>The tags to add to the deployment.</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_ListWorkloads.html"><c>ListWorkloads</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> <member name="T:Amazon.PowerShell.Cmdlets.LWIZ.RemoveLWIZResourceTagCmdlet"> <summary> Removes the specified tags from the given resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.RemoveLWIZResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.RemoveLWIZResourceTagCmdlet.TagKey"> <summary> <para> <para>Keys identifying the tags to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.RemoveLWIZResourceTagCmdlet.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.LaunchWizard.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LWIZ.RemoveLWIZResourceTagCmdlet.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.LWIZ.RemoveLWIZResourceTagCmdlet.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> |