/******************************************************************************* * 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 { /// /// Deletes a specified service within a cluster. You can delete a service if you have /// no running tasks in it and the desired task count is zero. If the service is actively /// maintaining tasks, you can't delete it, and you must update the service to a desired /// task count of zero. For more information, see UpdateService. /// /// /// When you delete a service, if there are still running tasks that require cleanup, /// the service status moves from ACTIVE to DRAINING, and the /// service is no longer visible in the console or in the ListServices API operation. /// After all tasks have transitioned to either STOPPING or STOPPED /// status, the service status moves from DRAINING to INACTIVE. /// Services in the DRAINING or INACTIVE status can still be /// viewed with the DescribeServices API operation. However, in the future, INACTIVE /// services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices /// calls on those services return a ServiceNotFoundException error. /// /// If you attempt to create a new service with the same name as an existing service in /// either ACTIVE or DRAINING status, you receive an error. /// /// [Cmdlet("Remove", "ECSService", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)] [OutputType("Amazon.ECS.Model.Service")] [AWSCmdlet("Calls the Amazon EC2 Container Service DeleteService API operation.", Operation = new[] {"DeleteService"}, SelectReturnType = typeof(Amazon.ECS.Model.DeleteServiceResponse))] [AWSCmdletOutput("Amazon.ECS.Model.Service or Amazon.ECS.Model.DeleteServiceResponse", "This cmdlet returns an Amazon.ECS.Model.Service object.", "The service call response (type Amazon.ECS.Model.DeleteServiceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RemoveECSServiceCmdlet : AmazonECSClientCmdlet, IExecutor { #region Parameter Cluster /// /// /// The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service /// to delete. 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 Enforce /// /// /// If true, allows you to delete a service even if it wasn't scaled down /// to zero tasks. It's only necessary to use this if the service uses the REPLICA /// scheduling strategy. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? Enforce { get; set; } #endregion #region Parameter Service /// /// /// The name of the service to delete. /// /// #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 Service { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Service'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ECS.Model.DeleteServiceResponse). /// Specifying the name of a property of type Amazon.ECS.Model.DeleteServiceResponse 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; } = "Service"; #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.Service), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-ECSService (DeleteService)")) { 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.Enforce = this.Enforce; context.Service = this.Service; #if MODULAR if (this.Service == null && ParameterWasBound(nameof(this.Service))) { WriteWarning("You are passing $null as a value for parameter Service 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.DeleteServiceRequest(); if (cmdletContext.Cluster != null) { request.Cluster = cmdletContext.Cluster; } if (cmdletContext.Enforce != null) { request.Force = cmdletContext.Enforce.Value; } if (cmdletContext.Service != null) { request.Service = cmdletContext.Service; } 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.DeleteServiceResponse CallAWSServiceOperation(IAmazonECS client, Amazon.ECS.Model.DeleteServiceRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon EC2 Container Service", "DeleteService"); try { #if DESKTOP return client.DeleteService(request); #elif CORECLR return client.DeleteServiceAsync(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.Boolean? Enforce { get; set; } public System.String Service { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Service; } } }