/*******************************************************************************
* 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
{
/// <summary>
/// Updates the Amazon ECS container agent on a specified container instance. Updating
/// the Amazon ECS container agent doesn't interrupt running tasks or services on the
/// container instance. The process for updating the agent differs depending on whether
/// your container instance was launched with the Amazon ECS-optimized AMI or another
/// operating system.
///
/// <note><para>
/// The <code>UpdateContainerAgent</code> API isn't supported for container instances
/// using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container
/// agent, you can update the <code>ecs-init</code> package. This updates the agent. For
/// more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html">Updating
/// the Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer
/// Guide</i>.
/// </para></note><note><para>
/// Agent updates with the <code>UpdateContainerAgent</code> API operation do not apply
/// to Windows container instances. We recommend that you launch new container instances
/// to update the agent version in your Windows clusters.
/// </para></note><para>
/// The <code>UpdateContainerAgent</code> API requires an Amazon ECS-optimized AMI or
/// Amazon Linux AMI with the <code>ecs-init</code> service installed and running. For
/// help updating the Amazon ECS container agent on other operating systems, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually
/// updating the Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service
/// Developer Guide</i>.
/// </para>
/// </summary>
[Cmdlet("Update", "ECSContainerAgent", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.ECS.Model.ContainerInstance")]
[AWSCmdlet("Calls the Amazon EC2 Container Service UpdateContainerAgent API operation.", Operation = new[] {"UpdateContainerAgent"}, SelectReturnType = typeof(Amazon.ECS.Model.UpdateContainerAgentResponse))]
[AWSCmdletOutput("Amazon.ECS.Model.ContainerInstance or Amazon.ECS.Model.UpdateContainerAgentResponse",
"This cmdlet returns an Amazon.ECS.Model.ContainerInstance object.",
"The service call response (type Amazon.ECS.Model.UpdateContainerAgentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateECSContainerAgentCmdlet : AmazonECSClientCmdlet, IExecutor
{
#region Parameter Cluster
/// <summary>
/// <para>
/// <para>The short name or full Amazon Resource Name (ARN) of the cluster that your container
/// instance is running on. If you do not specify a cluster, the default cluster is assumed.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String Cluster { get; set; }
#endregion
#region Parameter ContainerInstance
/// <summary>
/// <para>
/// <para>The container instance ID or full ARN entries for the container instance where you
/// would like to update the Amazon ECS container agent.</para>
/// </para>
/// </summary>
#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 ContainerInstance { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// Use the -Select parameter to control the cmdlet output. The default value is 'ContainerInstance'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ECS.Model.UpdateContainerAgentResponse).
/// Specifying the name of a property of type Amazon.ECS.Model.UpdateContainerAgentResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "ContainerInstance";
#endregion
#region Parameter PassThru
/// <summary>
/// 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.
/// </summary>
[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
/// <summary>
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
/// </summary>
[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-ECSContainerAgent (UpdateContainerAgent)"))
{
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<Amazon.ECS.Model.UpdateContainerAgentResponse, UpdateECSContainerAgentCmdlet>(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.ContainerInstance = this.ContainerInstance;
#if MODULAR
if (this.ContainerInstance == null && ParameterWasBound(nameof(this.ContainerInstance)))
{
WriteWarning("You are passing $null as a value for parameter ContainerInstance 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.UpdateContainerAgentRequest();
if (cmdletContext.Cluster != null)
{
request.Cluster = cmdletContext.Cluster;
}
if (cmdletContext.ContainerInstance != null)
{
request.ContainerInstance = cmdletContext.ContainerInstance;
}
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.UpdateContainerAgentResponse CallAWSServiceOperation(IAmazonECS client, Amazon.ECS.Model.UpdateContainerAgentRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon EC2 Container Service", "UpdateContainerAgent");
try
{
#if DESKTOP
return client.UpdateContainerAgent(request);
#elif CORECLR
return client.UpdateContainerAgentAsync(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 ContainerInstance { get; set; }
public System.Func<Amazon.ECS.Model.UpdateContainerAgentResponse, UpdateECSContainerAgentCmdlet, object> Select { get; set; } =
(response, cmdlet) => response.ContainerInstance;
}
}
}