/*******************************************************************************
* 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.CodeDeploy;
using Amazon.CodeDeploy.Model;
namespace Amazon.PowerShell.Cmdlets.CD
{
///
/// Returns an array of one or more targets associated with a deployment. This method
/// works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances
.
/// The maximum number of targets that can be returned is 25.
///
///
///
/// The type of targets returned depends on the deployment's compute platform or deployment
/// method:
/// - EC2/On-premises: Information about Amazon EC2 instance targets.
///
- Lambda: Information about Lambda functions targets.
///
- Amazon ECS: Information about Amazon ECS service targets.
///
- CloudFormation: Information about targets of blue/green deployments initiated
/// by a CloudFormation stack update.
///
///
[Cmdlet("Get", "CDDeploymentTargetBatch")]
[OutputType("Amazon.CodeDeploy.Model.DeploymentTarget")]
[AWSCmdlet("Calls the AWS CodeDeploy BatchGetDeploymentTargets API operation.", Operation = new[] {"BatchGetDeploymentTargets"}, SelectReturnType = typeof(Amazon.CodeDeploy.Model.BatchGetDeploymentTargetsResponse))]
[AWSCmdletOutput("Amazon.CodeDeploy.Model.DeploymentTarget or Amazon.CodeDeploy.Model.BatchGetDeploymentTargetsResponse",
"This cmdlet returns a collection of Amazon.CodeDeploy.Model.DeploymentTarget objects.",
"The service call response (type Amazon.CodeDeploy.Model.BatchGetDeploymentTargetsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetCDDeploymentTargetBatchCmdlet : AmazonCodeDeployClientCmdlet, IExecutor
{
#region Parameter DeploymentId
///
///
/// The unique ID of a deployment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DeploymentId { get; set; }
#endregion
#region Parameter TargetId
///
///
/// The unique IDs of the deployment targets. The compute platform of the deployment
/// determines the type of the targets and their formats. The maximum number of deployment
/// target IDs you can specify is 25.- For deployments that use the EC2/On-premises compute platform, the target IDs are
/// Amazon EC2 or on-premises instances IDs, and their target type is
instanceTarget
.
/// - For deployments that use the Lambda compute platform, the target IDs are the names
/// of Lambda functions, and their target type is
instanceTarget
. - For deployments that use the Amazon ECS compute platform, the target IDs are pairs
/// of Amazon ECS clusters and services specified using the format
<clustername>:<servicename>
.
/// Their target type is ecsTarget
. - For deployments that are deployed with CloudFormation, the target IDs are CloudFormation
/// stack IDs. Their target type is
cloudFormationTarget
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("TargetIds")]
public System.String[] TargetId { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'DeploymentTargets'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeDeploy.Model.BatchGetDeploymentTargetsResponse).
/// Specifying the name of a property of type Amazon.CodeDeploy.Model.BatchGetDeploymentTargetsResponse 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; } = "DeploymentTargets";
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.DeploymentId = this.DeploymentId;
if (this.TargetId != null)
{
context.TargetId = new List(this.TargetId);
}
// 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.CodeDeploy.Model.BatchGetDeploymentTargetsRequest();
if (cmdletContext.DeploymentId != null)
{
request.DeploymentId = cmdletContext.DeploymentId;
}
if (cmdletContext.TargetId != null)
{
request.TargetIds = cmdletContext.TargetId;
}
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.CodeDeploy.Model.BatchGetDeploymentTargetsResponse CallAWSServiceOperation(IAmazonCodeDeploy client, Amazon.CodeDeploy.Model.BatchGetDeploymentTargetsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS CodeDeploy", "BatchGetDeploymentTargets");
try
{
#if DESKTOP
return client.BatchGetDeploymentTargets(request);
#elif CORECLR
return client.BatchGetDeploymentTargetsAsync(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 DeploymentId { get; set; }
public List TargetId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.DeploymentTargets;
}
}
}