/******************************************************************************* * 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.OpsWorks; using Amazon.OpsWorks.Model; namespace Amazon.PowerShell.Cmdlets.OPS { /// /// Runs deployment or stack commands. For more information, see Deploying /// Apps and Run /// Stack Commands. /// /// /// Required Permissions: To use this action, an IAM user must have a Deploy or /// Manage permissions level for the stack, or an attached policy that explicitly grants /// permissions. For more information on user permissions, see Managing /// User Permissions. /// /// [Cmdlet("New", "OPSDeployment", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the AWS OpsWorks CreateDeployment API operation.", Operation = new[] {"CreateDeployment"}, SelectReturnType = typeof(Amazon.OpsWorks.Model.CreateDeploymentResponse))] [AWSCmdletOutput("System.String or Amazon.OpsWorks.Model.CreateDeploymentResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.OpsWorks.Model.CreateDeploymentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewOPSDeploymentCmdlet : AmazonOpsWorksClientCmdlet, IExecutor { #region Parameter AppId /// /// /// The app ID. This parameter is required for app deployments, but not for other deployment /// commands. /// /// [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] public System.String AppId { get; set; } #endregion #region Parameter Command_Arg /// /// /// The arguments of those commands that take arguments. It should be set to a JSON object /// with the following format:{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", /// ...], ...}The update_dependencies command takes two arguments:For example, to upgrade an instance to Amazon Linux 2016.09, set Args /// to the following. { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Command_Args")] public System.Collections.Hashtable Command_Arg { get; set; } #endregion #region Parameter Comment /// /// /// A user-defined comment. /// /// [System.Management.Automation.Parameter(Position = 3, ValueFromPipelineByPropertyName = true)] public System.String Comment { get; set; } #endregion #region Parameter CustomJson /// /// /// A string that contains user-defined, custom JSON. You can use this parameter to override /// some corresponding default stack configuration JSON values. The string should be in /// the following format:"{\"key1\": \"value1\", \"key2\": \"value2\",...}"For more information about custom JSON, see Use /// Custom JSON to Modify the Stack Configuration Attributes and Overriding /// Attributes With Custom JSON. /// /// [System.Management.Automation.Parameter(Position = 4, ValueFromPipelineByPropertyName = true)] public System.String CustomJson { get; set; } #endregion #region Parameter InstanceId /// /// /// The instance IDs for the deployment targets. /// /// [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)] [Alias("InstanceIds")] public System.String[] InstanceId { get; set; } #endregion #region Parameter LayerId /// /// /// The layer IDs for the deployment targets. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("LayerIds")] public System.String[] LayerId { get; set; } #endregion #region Parameter Command_Name /// /// /// Specifies the operation. You can specify only one command.For stacks, the following commands are available:The update_dependencies and install_dependencies commands are supported only for Linux /// instances. You can run the commands successfully on Windows instances, but they do /// nothing.For apps, the following commands are available: /// /// #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] [AWSConstantClassSource("Amazon.OpsWorks.DeploymentCommandName")] public Amazon.OpsWorks.DeploymentCommandName Command_Name { get; set; } #endregion #region Parameter StackId /// /// /// The stack ID. /// /// #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 StackId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'DeploymentId'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorks.Model.CreateDeploymentResponse). /// Specifying the name of a property of type Amazon.OpsWorks.Model.CreateDeploymentResponse 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; } = "DeploymentId"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the StackId parameter. /// The -PassThru parameter is deprecated, use -Select '^StackId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^StackId' 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.StackId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-OPSDeployment (CreateDeployment)")) { 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.StackId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AppId = this.AppId; if (this.Command_Arg != null) { context.Command_Arg = new Dictionary>(StringComparer.Ordinal); foreach (var hashKey in this.Command_Arg.Keys) { object hashValue = this.Command_Arg[hashKey]; if (hashValue == null) { context.Command_Arg.Add((String)hashKey, null); continue; } var enumerable = SafeEnumerable(hashValue); var valueSet = new List(); foreach (var s in enumerable) { valueSet.Add((System.String)s); } context.Command_Arg.Add((String)hashKey, valueSet); } } context.Command_Name = this.Command_Name; #if MODULAR if (this.Command_Name == null && ParameterWasBound(nameof(this.Command_Name))) { WriteWarning("You are passing $null as a value for parameter Command_Name 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.Comment = this.Comment; context.CustomJson = this.CustomJson; if (this.InstanceId != null) { context.InstanceId = new List(this.InstanceId); } if (this.LayerId != null) { context.LayerId = new List(this.LayerId); } context.StackId = this.StackId; #if MODULAR if (this.StackId == null && ParameterWasBound(nameof(this.StackId))) { WriteWarning("You are passing $null as a value for parameter StackId 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.OpsWorks.Model.CreateDeploymentRequest(); if (cmdletContext.AppId != null) { request.AppId = cmdletContext.AppId; } // populate Command var requestCommandIsNull = true; request.Command = new Amazon.OpsWorks.Model.DeploymentCommand(); Dictionary> requestCommand_command_Arg = null; if (cmdletContext.Command_Arg != null) { requestCommand_command_Arg = cmdletContext.Command_Arg; } if (requestCommand_command_Arg != null) { request.Command.Args = requestCommand_command_Arg; requestCommandIsNull = false; } Amazon.OpsWorks.DeploymentCommandName requestCommand_command_Name = null; if (cmdletContext.Command_Name != null) { requestCommand_command_Name = cmdletContext.Command_Name; } if (requestCommand_command_Name != null) { request.Command.Name = requestCommand_command_Name; requestCommandIsNull = false; } // determine if request.Command should be set to null if (requestCommandIsNull) { request.Command = null; } if (cmdletContext.Comment != null) { request.Comment = cmdletContext.Comment; } if (cmdletContext.CustomJson != null) { request.CustomJson = cmdletContext.CustomJson; } if (cmdletContext.InstanceId != null) { request.InstanceIds = cmdletContext.InstanceId; } if (cmdletContext.LayerId != null) { request.LayerIds = cmdletContext.LayerId; } if (cmdletContext.StackId != null) { request.StackId = cmdletContext.StackId; } 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.OpsWorks.Model.CreateDeploymentResponse CallAWSServiceOperation(IAmazonOpsWorks client, Amazon.OpsWorks.Model.CreateDeploymentRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS OpsWorks", "CreateDeployment"); try { #if DESKTOP return client.CreateDeployment(request); #elif CORECLR return client.CreateDeploymentAsync(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 AppId { get; set; } public Dictionary> Command_Arg { get; set; } public Amazon.OpsWorks.DeploymentCommandName Command_Name { get; set; } public System.String Comment { get; set; } public System.String CustomJson { get; set; } public List InstanceId { get; set; } public List LayerId { get; set; } public System.String StackId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.DeploymentId; } } }