/******************************************************************************* * 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.MainframeModernization; using Amazon.MainframeModernization.Model; namespace Amazon.PowerShell.Cmdlets.AMM { /// /// Updates the configuration details for a specific runtime environment. /// [Cmdlet("Update", "AMMEnvironment", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the M2 UpdateEnvironment API operation.", Operation = new[] {"UpdateEnvironment"}, SelectReturnType = typeof(Amazon.MainframeModernization.Model.UpdateEnvironmentResponse))] [AWSCmdletOutput("System.String or Amazon.MainframeModernization.Model.UpdateEnvironmentResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.MainframeModernization.Model.UpdateEnvironmentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateAMMEnvironmentCmdlet : AmazonMainframeModernizationClientCmdlet, IExecutor { #region Parameter ApplyDuringMaintenanceWindow /// /// /// Indicates whether to update the runtime environment during the maintenance window. /// The default is false. Currently, Amazon Web Services Mainframe Modernization accepts /// the engineVersion parameter only if applyDuringMaintenanceWindow /// is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, /// it will fail if applyDuringMaintenanceWindow is set to true. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? ApplyDuringMaintenanceWindow { get; set; } #endregion #region Parameter DesiredCapacity /// /// /// The desired capacity for the runtime environment to update. The minimum possible value /// is 0 and the maximum is 100. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? DesiredCapacity { get; set; } #endregion #region Parameter EngineVersion /// /// /// The version of the runtime engine for the runtime environment. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String EngineVersion { get; set; } #endregion #region Parameter EnvironmentId /// /// /// The unique identifier of the runtime environment that you want to update. /// /// #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 EnvironmentId { get; set; } #endregion #region Parameter InstanceType /// /// /// The instance type for the runtime environment to update. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String InstanceType { get; set; } #endregion #region Parameter PreferredMaintenanceWindow /// /// /// Configures the maintenance window you want for the runtime environment. If you do /// not provide a value, a random system-generated value will be assigned. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PreferredMaintenanceWindow { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentId'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MainframeModernization.Model.UpdateEnvironmentResponse). /// Specifying the name of a property of type Amazon.MainframeModernization.Model.UpdateEnvironmentResponse 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; } = "EnvironmentId"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the EnvironmentId parameter. /// The -PassThru parameter is deprecated, use -Select '^EnvironmentId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^EnvironmentId' 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.EnvironmentId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-AMMEnvironment (UpdateEnvironment)")) { 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.EnvironmentId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ApplyDuringMaintenanceWindow = this.ApplyDuringMaintenanceWindow; context.DesiredCapacity = this.DesiredCapacity; context.EngineVersion = this.EngineVersion; context.EnvironmentId = this.EnvironmentId; #if MODULAR if (this.EnvironmentId == null && ParameterWasBound(nameof(this.EnvironmentId))) { WriteWarning("You are passing $null as a value for parameter EnvironmentId 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.InstanceType = this.InstanceType; context.PreferredMaintenanceWindow = this.PreferredMaintenanceWindow; // 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.MainframeModernization.Model.UpdateEnvironmentRequest(); if (cmdletContext.ApplyDuringMaintenanceWindow != null) { request.ApplyDuringMaintenanceWindow = cmdletContext.ApplyDuringMaintenanceWindow.Value; } if (cmdletContext.DesiredCapacity != null) { request.DesiredCapacity = cmdletContext.DesiredCapacity.Value; } if (cmdletContext.EngineVersion != null) { request.EngineVersion = cmdletContext.EngineVersion; } if (cmdletContext.EnvironmentId != null) { request.EnvironmentId = cmdletContext.EnvironmentId; } if (cmdletContext.InstanceType != null) { request.InstanceType = cmdletContext.InstanceType; } if (cmdletContext.PreferredMaintenanceWindow != null) { request.PreferredMaintenanceWindow = cmdletContext.PreferredMaintenanceWindow; } 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.MainframeModernization.Model.UpdateEnvironmentResponse CallAWSServiceOperation(IAmazonMainframeModernization client, Amazon.MainframeModernization.Model.UpdateEnvironmentRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "M2", "UpdateEnvironment"); try { #if DESKTOP return client.UpdateEnvironment(request); #elif CORECLR return client.UpdateEnvironmentAsync(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.Boolean? ApplyDuringMaintenanceWindow { get; set; } public System.Int32? DesiredCapacity { get; set; } public System.String EngineVersion { get; set; } public System.String EnvironmentId { get; set; } public System.String InstanceType { get; set; } public System.String PreferredMaintenanceWindow { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.EnvironmentId; } } }