/******************************************************************************* * 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 { /// /// Updates the protection status of a task. You can set protectionEnabled /// to true to protect your task from termination during scale-in events /// from Service /// Autoscaling or deployments. /// /// /// /// Task-protection, by default, expires after 2 hours at which point Amazon ECS clears /// the protectionEnabled property making the task eligible for termination /// by a subsequent scale-in event. /// /// You can specify a custom expiration period for task protection from 1 minute to up /// to 2,880 minutes (48 hours). To specify the custom expiration period, set the expiresInMinutes /// property. The expiresInMinutes property is always reset when you invoke /// this operation for a task that already has protectionEnabled set to true. /// You can keep extending the protection expiration period of a task by invoking this /// operation repeatedly. /// /// To learn more about Amazon ECS task protection, see Task /// scale-in protection in the Amazon Elastic Container Service Developer Guide. /// /// This operation is only supported for tasks belonging to an Amazon ECS service. Invoking /// this operation for a standalone task will result in an TASK_NOT_VALID /// failure. For more information, see API /// failure reasons. /// /// If you prefer to set task protection from within the container, we recommend using /// the Task /// scale-in protection endpoint. /// /// [Cmdlet("Update", "ECSTaskProtection", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.ECS.Model.UpdateTaskProtectionResponse")] [AWSCmdlet("Calls the Amazon EC2 Container Service UpdateTaskProtection API operation.", Operation = new[] {"UpdateTaskProtection"}, SelectReturnType = typeof(Amazon.ECS.Model.UpdateTaskProtectionResponse))] [AWSCmdletOutput("Amazon.ECS.Model.UpdateTaskProtectionResponse", "This cmdlet returns an Amazon.ECS.Model.UpdateTaskProtectionResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateECSTaskProtectionCmdlet : AmazonECSClientCmdlet, IExecutor { #region Parameter Cluster /// /// /// The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service /// that the task sets exist in. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] #else [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Cluster { get; set; } #endregion #region Parameter ExpiresInMinute /// /// /// If you set protectionEnabled to true, you can specify the /// duration for task protection in minutes. You can specify a value from 1 minute to /// up to 2,880 minutes (48 hours). During this time, your task will not be terminated /// by scale-in events from Service Auto Scaling or deployments. After this time period /// lapses, protectionEnabled will be reset to false.If you don’t specify the time, then the task is automatically protected for 120 minutes /// (2 hours). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ExpiresInMinutes")] public System.Int32? ExpiresInMinute { get; set; } #endregion #region Parameter ProtectionEnabled /// /// /// Specify true to mark a task for protection and false to /// unset protection, making it eligible for termination. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.Boolean? ProtectionEnabled { get; set; } #endregion #region Parameter Task /// /// /// A list of up to 10 task IDs or full ARN entries. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Alias("Tasks")] public System.String[] Task { get; set; } #endregion #region Parameter Select /// /// 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.ECS.Model.UpdateTaskProtectionResponse). /// Specifying the name of a property of type Amazon.ECS.Model.UpdateTaskProtectionResponse 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; } = "*"; #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, "Update-ECSTaskProtection (UpdateTaskProtection)")) { 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; #if MODULAR if (this.Cluster == null && ParameterWasBound(nameof(this.Cluster))) { WriteWarning("You are passing $null as a value for parameter Cluster 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 context.ExpiresInMinute = this.ExpiresInMinute; context.ProtectionEnabled = this.ProtectionEnabled; #if MODULAR if (this.ProtectionEnabled == null && ParameterWasBound(nameof(this.ProtectionEnabled))) { WriteWarning("You are passing $null as a value for parameter ProtectionEnabled 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 if (this.Task != null) { context.Task = new List(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.UpdateTaskProtectionRequest(); if (cmdletContext.Cluster != null) { request.Cluster = cmdletContext.Cluster; } if (cmdletContext.ExpiresInMinute != null) { request.ExpiresInMinutes = cmdletContext.ExpiresInMinute.Value; } if (cmdletContext.ProtectionEnabled != null) { request.ProtectionEnabled = cmdletContext.ProtectionEnabled.Value; } if (cmdletContext.Task != null) { request.Tasks = 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.UpdateTaskProtectionResponse CallAWSServiceOperation(IAmazonECS client, Amazon.ECS.Model.UpdateTaskProtectionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon EC2 Container Service", "UpdateTaskProtection"); try { #if DESKTOP return client.UpdateTaskProtection(request); #elif CORECLR return client.UpdateTaskProtectionAsync(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.Int32? ExpiresInMinute { get; set; } public System.Boolean? ProtectionEnabled { get; set; } public List Task { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }