/*******************************************************************************
* 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
{
///
/// Runs a command remotely on a container within a task.
///
///
///
/// If you use a condition key in your IAM policy to refine the conditions for the policy
/// statement, for example limit the actions to a specific cluster, you receive an AccessDeniedException
/// when there is a mismatch between the condition key value and the corresponding parameter
/// value.
///
/// For information about required permissions and considerations, see Using
/// Amazon ECS Exec for debugging in the Amazon ECS Developer Guide.
///
///
[Cmdlet("Invoke", "ECSCommand", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.ECS.Model.ExecuteCommandResponse")]
[AWSCmdlet("Calls the Amazon EC2 Container Service ExecuteCommand API operation.", Operation = new[] {"ExecuteCommand"}, SelectReturnType = typeof(Amazon.ECS.Model.ExecuteCommandResponse))]
[AWSCmdletOutput("Amazon.ECS.Model.ExecuteCommandResponse",
"This cmdlet returns an Amazon.ECS.Model.ExecuteCommandResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class InvokeECSCommandCmdlet : AmazonECSClientCmdlet, IExecutor
{
protected override bool IsSensitiveResponse { get; set; } = true;
#region Parameter Cluster
///
///
/// The Amazon Resource Name (ARN) or short name of the cluster the task is running in.
/// 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 Command
///
///
/// The command to run on the container.
///
///
#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 Command { get; set; }
#endregion
#region Parameter Container
///
///
/// The name of the container to execute the command on. A container name only needs to
/// be specified for tasks containing multiple containers.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Container { get; set; }
#endregion
#region Parameter Interactive
///
///
/// Use this flag to run your command in interactive mode.
///
///
#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? Interactive { get; set; }
#endregion
#region Parameter Task
///
///
/// The Amazon Resource Name (ARN) or ID of the task the container is part of.
///
///
#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 '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ECS.Model.ExecuteCommandResponse).
/// Specifying the name of a property of type Amazon.ECS.Model.ExecuteCommandResponse 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, "Invoke-ECSCommand (ExecuteCommand)"))
{
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.Command = this.Command;
#if MODULAR
if (this.Command == null && ParameterWasBound(nameof(this.Command)))
{
WriteWarning("You are passing $null as a value for parameter Command 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.Container = this.Container;
context.Interactive = this.Interactive;
#if MODULAR
if (this.Interactive == null && ParameterWasBound(nameof(this.Interactive)))
{
WriteWarning("You are passing $null as a value for parameter Interactive 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.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.ExecuteCommandRequest();
if (cmdletContext.Cluster != null)
{
request.Cluster = cmdletContext.Cluster;
}
if (cmdletContext.Command != null)
{
request.Command = cmdletContext.Command;
}
if (cmdletContext.Container != null)
{
request.Container = cmdletContext.Container;
}
if (cmdletContext.Interactive != null)
{
request.Interactive = cmdletContext.Interactive.Value;
}
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.ExecuteCommandResponse CallAWSServiceOperation(IAmazonECS client, Amazon.ECS.Model.ExecuteCommandRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon EC2 Container Service", "ExecuteCommand");
try
{
#if DESKTOP
return client.ExecuteCommand(request);
#elif CORECLR
return client.ExecuteCommandAsync(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 Command { get; set; }
public System.String Container { get; set; }
public System.Boolean? Interactive { get; set; }
public System.String Task { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}