/*******************************************************************************
* 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
{
///
/// Gets information about an application revision.
///
[Cmdlet("Get", "CDApplicationRevision")]
[OutputType("Amazon.CodeDeploy.Model.GetApplicationRevisionResponse")]
[AWSCmdlet("Calls the AWS CodeDeploy GetApplicationRevision API operation.", Operation = new[] {"GetApplicationRevision"}, SelectReturnType = typeof(Amazon.CodeDeploy.Model.GetApplicationRevisionResponse))]
[AWSCmdletOutput("Amazon.CodeDeploy.Model.GetApplicationRevisionResponse",
"This cmdlet returns an Amazon.CodeDeploy.Model.GetApplicationRevisionResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetCDApplicationRevisionCmdlet : AmazonCodeDeployClientCmdlet, IExecutor
{
#region Parameter ApplicationName
///
///
/// The name of the application that corresponds to the revision.
///
///
#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 ApplicationName { get; set; }
#endregion
#region Parameter S3Location_Bucket
///
///
/// The name of the Amazon S3 bucket where the application revision is stored.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Revision_S3Location_Bucket")]
public System.String S3Location_Bucket { get; set; }
#endregion
#region Parameter S3Location_BundleType
///
///
/// The file type of the application revision. Must be one of the following:tar
: A tar archive file.tgz
: A compressed tar archive file.zip
: A zip archive file.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Revision_S3Location_BundleType")]
[AWSConstantClassSource("Amazon.CodeDeploy.BundleType")]
public Amazon.CodeDeploy.BundleType S3Location_BundleType { get; set; }
#endregion
#region Parameter GitHubLocation_CommitId
///
///
/// The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for
/// the application revision.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Revision_GitHubLocation_CommitId")]
public System.String GitHubLocation_CommitId { get; set; }
#endregion
#region Parameter AppSpecContent_Content
///
///
/// The YAML-formatted or JSON-formatted revision string. For an Lambda deployment, the content includes a Lambda function name, the alias
/// for its original version, and the alias for its replacement version. The deployment
/// shifts traffic from the original version of the Lambda function to the replacement
/// version. For an Amazon ECS deployment, the content includes the task name, information about
/// the load balancer that serves traffic to the container, and more. For both types of deployments, the content can specify Lambda functions that run
/// at specified hooks, such as BeforeInstall
, during a deployment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Revision_AppSpecContent_Content")]
public System.String AppSpecContent_Content { get; set; }
#endregion
#region Parameter String_Content
///
///
/// The YAML-formatted or JSON-formatted revision string. It includes information about
/// which Lambda function to update and optional Lambda functions that validate deployment
/// lifecycle events.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Revision_String_Content")]
public System.String String_Content { get; set; }
#endregion
#region Parameter S3Location_ETag
///
///
/// The ETag of the Amazon S3 object that represents the bundled artifacts for the application
/// revision.If the ETag is not specified as an input parameter, ETag validation of the object
/// is skipped.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Revision_S3Location_ETag")]
public System.String S3Location_ETag { get; set; }
#endregion
#region Parameter S3Location_Key
///
///
/// The name of the Amazon S3 object that represents the bundled artifacts for the application
/// revision.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Revision_S3Location_Key")]
public System.String S3Location_Key { get; set; }
#endregion
#region Parameter GitHubLocation_Repository
///
///
/// The GitHub account and repository pair that stores a reference to the commit that
/// represents the bundled artifacts for the application revision. Specified as account/repository.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Revision_GitHubLocation_Repository")]
public System.String GitHubLocation_Repository { get; set; }
#endregion
#region Parameter Revision_RevisionType
///
///
/// The type of application revision:- S3: An application revision stored in Amazon S3.
- GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).
- String: A YAML-formatted or JSON-formatted string (Lambda deployments only).
- AppSpecContent: An
AppSpecContent
object that contains the contents of
/// an AppSpec file for an Lambda or Amazon ECS deployment. The content is formatted as
/// JSON or YAML stored as a RawString.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.CodeDeploy.RevisionLocationType")]
public Amazon.CodeDeploy.RevisionLocationType Revision_RevisionType { get; set; }
#endregion
#region Parameter AppSpecContent_Sha256
///
///
/// The SHA256 hash value of the revision content.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Revision_AppSpecContent_Sha256")]
public System.String AppSpecContent_Sha256 { get; set; }
#endregion
#region Parameter String_Sha256
///
///
/// The SHA256 hash value of the revision content.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Revision_String_Sha256")]
public System.String String_Sha256 { get; set; }
#endregion
#region Parameter S3Location_Version
///
///
/// A specific version of the Amazon S3 object that represents the bundled artifacts for
/// the application revision.If the version is not specified, the system uses the most recent version by default.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Revision_S3Location_Version")]
public System.String S3Location_Version { 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.CodeDeploy.Model.GetApplicationRevisionResponse).
/// Specifying the name of a property of type Amazon.CodeDeploy.Model.GetApplicationRevisionResponse 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 ApplicationName parameter.
/// The -PassThru parameter is deprecated, use -Select '^ApplicationName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ApplicationName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#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);
#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.ApplicationName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ApplicationName = this.ApplicationName;
#if MODULAR
if (this.ApplicationName == null && ParameterWasBound(nameof(this.ApplicationName)))
{
WriteWarning("You are passing $null as a value for parameter ApplicationName 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.AppSpecContent_Content = this.AppSpecContent_Content;
context.AppSpecContent_Sha256 = this.AppSpecContent_Sha256;
context.GitHubLocation_CommitId = this.GitHubLocation_CommitId;
context.GitHubLocation_Repository = this.GitHubLocation_Repository;
context.Revision_RevisionType = this.Revision_RevisionType;
context.S3Location_Bucket = this.S3Location_Bucket;
context.S3Location_BundleType = this.S3Location_BundleType;
context.S3Location_ETag = this.S3Location_ETag;
context.S3Location_Key = this.S3Location_Key;
context.S3Location_Version = this.S3Location_Version;
context.String_Content = this.String_Content;
context.String_Sha256 = this.String_Sha256;
// 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.GetApplicationRevisionRequest();
if (cmdletContext.ApplicationName != null)
{
request.ApplicationName = cmdletContext.ApplicationName;
}
// populate Revision
var requestRevisionIsNull = true;
request.Revision = new Amazon.CodeDeploy.Model.RevisionLocation();
Amazon.CodeDeploy.RevisionLocationType requestRevision_revision_RevisionType = null;
if (cmdletContext.Revision_RevisionType != null)
{
requestRevision_revision_RevisionType = cmdletContext.Revision_RevisionType;
}
if (requestRevision_revision_RevisionType != null)
{
request.Revision.RevisionType = requestRevision_revision_RevisionType;
requestRevisionIsNull = false;
}
Amazon.CodeDeploy.Model.AppSpecContent requestRevision_revision_AppSpecContent = null;
// populate AppSpecContent
var requestRevision_revision_AppSpecContentIsNull = true;
requestRevision_revision_AppSpecContent = new Amazon.CodeDeploy.Model.AppSpecContent();
System.String requestRevision_revision_AppSpecContent_appSpecContent_Content = null;
if (cmdletContext.AppSpecContent_Content != null)
{
requestRevision_revision_AppSpecContent_appSpecContent_Content = cmdletContext.AppSpecContent_Content;
}
if (requestRevision_revision_AppSpecContent_appSpecContent_Content != null)
{
requestRevision_revision_AppSpecContent.Content = requestRevision_revision_AppSpecContent_appSpecContent_Content;
requestRevision_revision_AppSpecContentIsNull = false;
}
System.String requestRevision_revision_AppSpecContent_appSpecContent_Sha256 = null;
if (cmdletContext.AppSpecContent_Sha256 != null)
{
requestRevision_revision_AppSpecContent_appSpecContent_Sha256 = cmdletContext.AppSpecContent_Sha256;
}
if (requestRevision_revision_AppSpecContent_appSpecContent_Sha256 != null)
{
requestRevision_revision_AppSpecContent.Sha256 = requestRevision_revision_AppSpecContent_appSpecContent_Sha256;
requestRevision_revision_AppSpecContentIsNull = false;
}
// determine if requestRevision_revision_AppSpecContent should be set to null
if (requestRevision_revision_AppSpecContentIsNull)
{
requestRevision_revision_AppSpecContent = null;
}
if (requestRevision_revision_AppSpecContent != null)
{
request.Revision.AppSpecContent = requestRevision_revision_AppSpecContent;
requestRevisionIsNull = false;
}
Amazon.CodeDeploy.Model.GitHubLocation requestRevision_revision_GitHubLocation = null;
// populate GitHubLocation
var requestRevision_revision_GitHubLocationIsNull = true;
requestRevision_revision_GitHubLocation = new Amazon.CodeDeploy.Model.GitHubLocation();
System.String requestRevision_revision_GitHubLocation_gitHubLocation_CommitId = null;
if (cmdletContext.GitHubLocation_CommitId != null)
{
requestRevision_revision_GitHubLocation_gitHubLocation_CommitId = cmdletContext.GitHubLocation_CommitId;
}
if (requestRevision_revision_GitHubLocation_gitHubLocation_CommitId != null)
{
requestRevision_revision_GitHubLocation.CommitId = requestRevision_revision_GitHubLocation_gitHubLocation_CommitId;
requestRevision_revision_GitHubLocationIsNull = false;
}
System.String requestRevision_revision_GitHubLocation_gitHubLocation_Repository = null;
if (cmdletContext.GitHubLocation_Repository != null)
{
requestRevision_revision_GitHubLocation_gitHubLocation_Repository = cmdletContext.GitHubLocation_Repository;
}
if (requestRevision_revision_GitHubLocation_gitHubLocation_Repository != null)
{
requestRevision_revision_GitHubLocation.Repository = requestRevision_revision_GitHubLocation_gitHubLocation_Repository;
requestRevision_revision_GitHubLocationIsNull = false;
}
// determine if requestRevision_revision_GitHubLocation should be set to null
if (requestRevision_revision_GitHubLocationIsNull)
{
requestRevision_revision_GitHubLocation = null;
}
if (requestRevision_revision_GitHubLocation != null)
{
request.Revision.GitHubLocation = requestRevision_revision_GitHubLocation;
requestRevisionIsNull = false;
}
Amazon.CodeDeploy.Model.RawString requestRevision_revision_String = null;
// populate String
var requestRevision_revision_StringIsNull = true;
requestRevision_revision_String = new Amazon.CodeDeploy.Model.RawString();
System.String requestRevision_revision_String_string_Content = null;
if (cmdletContext.String_Content != null)
{
requestRevision_revision_String_string_Content = cmdletContext.String_Content;
}
if (requestRevision_revision_String_string_Content != null)
{
requestRevision_revision_String.Content = requestRevision_revision_String_string_Content;
requestRevision_revision_StringIsNull = false;
}
System.String requestRevision_revision_String_string_Sha256 = null;
if (cmdletContext.String_Sha256 != null)
{
requestRevision_revision_String_string_Sha256 = cmdletContext.String_Sha256;
}
if (requestRevision_revision_String_string_Sha256 != null)
{
requestRevision_revision_String.Sha256 = requestRevision_revision_String_string_Sha256;
requestRevision_revision_StringIsNull = false;
}
// determine if requestRevision_revision_String should be set to null
if (requestRevision_revision_StringIsNull)
{
requestRevision_revision_String = null;
}
if (requestRevision_revision_String != null)
{
request.Revision.String = requestRevision_revision_String;
requestRevisionIsNull = false;
}
Amazon.CodeDeploy.Model.S3Location requestRevision_revision_S3Location = null;
// populate S3Location
var requestRevision_revision_S3LocationIsNull = true;
requestRevision_revision_S3Location = new Amazon.CodeDeploy.Model.S3Location();
System.String requestRevision_revision_S3Location_s3Location_Bucket = null;
if (cmdletContext.S3Location_Bucket != null)
{
requestRevision_revision_S3Location_s3Location_Bucket = cmdletContext.S3Location_Bucket;
}
if (requestRevision_revision_S3Location_s3Location_Bucket != null)
{
requestRevision_revision_S3Location.Bucket = requestRevision_revision_S3Location_s3Location_Bucket;
requestRevision_revision_S3LocationIsNull = false;
}
Amazon.CodeDeploy.BundleType requestRevision_revision_S3Location_s3Location_BundleType = null;
if (cmdletContext.S3Location_BundleType != null)
{
requestRevision_revision_S3Location_s3Location_BundleType = cmdletContext.S3Location_BundleType;
}
if (requestRevision_revision_S3Location_s3Location_BundleType != null)
{
requestRevision_revision_S3Location.BundleType = requestRevision_revision_S3Location_s3Location_BundleType;
requestRevision_revision_S3LocationIsNull = false;
}
System.String requestRevision_revision_S3Location_s3Location_ETag = null;
if (cmdletContext.S3Location_ETag != null)
{
requestRevision_revision_S3Location_s3Location_ETag = cmdletContext.S3Location_ETag;
}
if (requestRevision_revision_S3Location_s3Location_ETag != null)
{
requestRevision_revision_S3Location.ETag = requestRevision_revision_S3Location_s3Location_ETag;
requestRevision_revision_S3LocationIsNull = false;
}
System.String requestRevision_revision_S3Location_s3Location_Key = null;
if (cmdletContext.S3Location_Key != null)
{
requestRevision_revision_S3Location_s3Location_Key = cmdletContext.S3Location_Key;
}
if (requestRevision_revision_S3Location_s3Location_Key != null)
{
requestRevision_revision_S3Location.Key = requestRevision_revision_S3Location_s3Location_Key;
requestRevision_revision_S3LocationIsNull = false;
}
System.String requestRevision_revision_S3Location_s3Location_Version = null;
if (cmdletContext.S3Location_Version != null)
{
requestRevision_revision_S3Location_s3Location_Version = cmdletContext.S3Location_Version;
}
if (requestRevision_revision_S3Location_s3Location_Version != null)
{
requestRevision_revision_S3Location.Version = requestRevision_revision_S3Location_s3Location_Version;
requestRevision_revision_S3LocationIsNull = false;
}
// determine if requestRevision_revision_S3Location should be set to null
if (requestRevision_revision_S3LocationIsNull)
{
requestRevision_revision_S3Location = null;
}
if (requestRevision_revision_S3Location != null)
{
request.Revision.S3Location = requestRevision_revision_S3Location;
requestRevisionIsNull = false;
}
// determine if request.Revision should be set to null
if (requestRevisionIsNull)
{
request.Revision = null;
}
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.GetApplicationRevisionResponse CallAWSServiceOperation(IAmazonCodeDeploy client, Amazon.CodeDeploy.Model.GetApplicationRevisionRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS CodeDeploy", "GetApplicationRevision");
try
{
#if DESKTOP
return client.GetApplicationRevision(request);
#elif CORECLR
return client.GetApplicationRevisionAsync(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 ApplicationName { get; set; }
public System.String AppSpecContent_Content { get; set; }
public System.String AppSpecContent_Sha256 { get; set; }
public System.String GitHubLocation_CommitId { get; set; }
public System.String GitHubLocation_Repository { get; set; }
public Amazon.CodeDeploy.RevisionLocationType Revision_RevisionType { get; set; }
public System.String S3Location_Bucket { get; set; }
public Amazon.CodeDeploy.BundleType S3Location_BundleType { get; set; }
public System.String S3Location_ETag { get; set; }
public System.String S3Location_Key { get; set; }
public System.String S3Location_Version { get; set; }
public System.String String_Content { get; set; }
public System.String String_Sha256 { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}