/******************************************************************************* * Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * Licensed under the Apache License, Version 2.0 (the "License"). You may not use * this file except in compliance with the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.ECS; using Amazon.ECS.Model; namespace Amazon.PowerShell.Cmdlets.ECS { /// /// Stops a running task. Any tags associated with the task will be deleted. /// /// /// /// When StopTask is called on a task, the equivalent of docker stop /// is issued to the containers running in the task. This results in a SIGTERM /// value and a default 30-second timeout, after which the SIGKILL value /// is sent and the containers are forcibly stopped. If the container handles the SIGTERM /// value gracefully and exits within 30 seconds from receiving it, no SIGKILL /// value is sent. /// /// The default 30-second timeout can be configured on the Amazon ECS container agent /// with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see /// Amazon /// ECS Container Agent Configuration in the Amazon Elastic Container Service Developer /// Guide. /// /// [Cmdlet("Stop", "ECSTask", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.ECS.Model.Task")] [AWSCmdlet("Calls the Amazon EC2 Container Service StopTask API operation.", Operation = new[] {"StopTask"}, SelectReturnType = typeof(Amazon.ECS.Model.StopTaskResponse))] [AWSCmdletOutput("Amazon.ECS.Model.Task or Amazon.ECS.Model.StopTaskResponse", "This cmdlet returns an Amazon.ECS.Model.Task object.", "The service call response (type Amazon.ECS.Model.StopTaskResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class StopECSTaskCmdlet : AmazonECSClientCmdlet, IExecutor { #region Parameter Cluster /// /// /// The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task /// to stop. If you do not specify a cluster, the default cluster is assumed. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String Cluster { get; set; } #endregion #region Parameter Reason /// /// /// An optional message specified when a task is stopped. For example, if you're using /// a custom scheduler, you can use this parameter to specify the reason for stopping /// the task here, and the message appears in subsequent DescribeTasks API operations /// on this task. Up to 255 characters are allowed in this message. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Reason { get; set; } #endregion #region Parameter Task /// /// /// The task ID of the task to stop. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Task { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Task'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ECS.Model.StopTaskResponse). /// Specifying the name of a property of type Amazon.ECS.Model.StopTaskResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "Task"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Cluster parameter. /// The -PassThru parameter is deprecated, use -Select '^Cluster' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Cluster' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter Force /// /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter Force { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.Cluster), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Stop-ECSTask (StopTask)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); if (this.PassThru.IsPresent) { throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select)); } } else if (this.PassThru.IsPresent) { context.Select = (response, cmdlet) => this.Cluster; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Cluster = this.Cluster; context.Reason = this.Reason; context.Task = this.Task; #if MODULAR if (this.Task == null && ParameterWasBound(nameof(this.Task))) { WriteWarning("You are passing $null as a value for parameter Task which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.ECS.Model.StopTaskRequest(); if (cmdletContext.Cluster != null) { request.Cluster = cmdletContext.Cluster; } if (cmdletContext.Reason != null) { request.Reason = cmdletContext.Reason; } if (cmdletContext.Task != null) { request.Task = cmdletContext.Task; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.ECS.Model.StopTaskResponse CallAWSServiceOperation(IAmazonECS client, Amazon.ECS.Model.StopTaskRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon EC2 Container Service", "StopTask"); try { #if DESKTOP return client.StopTask(request); #elif CORECLR return client.StopTaskAsync(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public System.String Cluster { get; set; } public System.String Reason { get; set; } public System.String Task { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Task; } } }