/******************************************************************************* * 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.ElasticBeanstalk; using Amazon.ElasticBeanstalk.Model; namespace Amazon.PowerShell.Cmdlets.EB { /// /// Updates the environment description, deploys a new application version, updates the /// configuration settings to an entirely new configuration template, or updates select /// configuration option values in the running environment. /// /// /// /// Attempting to update both the release and configuration is not allowed and AWS Elastic /// Beanstalk returns an InvalidParameterCombination error. /// /// When updating the configuration settings to a new template or individual settings, /// a draft configuration is created and DescribeConfigurationSettings for this /// environment returns two setting descriptions with different DeploymentStatus /// values. /// /// [Cmdlet("Update", "EBEnvironment", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResponse")] [AWSCmdlet("Calls the AWS Elastic Beanstalk UpdateEnvironment API operation.", Operation = new[] {"UpdateEnvironment"}, SelectReturnType = typeof(Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResponse))] [AWSCmdletOutput("Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResponse", "This cmdlet returns an Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateEBEnvironmentCmdlet : AmazonElasticBeanstalkClientCmdlet, IExecutor { #region Parameter ApplicationName /// /// /// The name of the application with which the environment is associated. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ApplicationName { get; set; } #endregion #region Parameter Description /// /// /// If this parameter is specified, AWS Elastic Beanstalk updates the description of this /// environment. /// /// [System.Management.Automation.Parameter(Position = 4, ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter EnvironmentId /// /// /// The ID of the environment to update.If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue /// error.Condition: You must specify either this or an EnvironmentName, or both. If you do /// not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter /// error. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String EnvironmentId { get; set; } #endregion #region Parameter EnvironmentName /// /// /// The name of the environment to update. If no environment with this name exists, AWS /// Elastic Beanstalk returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentId, or both. If you do not /// specify either, AWS Elastic Beanstalk returns MissingRequiredParameter /// error. /// /// [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] public System.String EnvironmentName { get; set; } #endregion #region Parameter GroupName /// /// /// The name of the group to which the target environment belongs. Specify a group name /// only if the environment's name is specified in an environment manifest and not with /// the environment name or environment ID parameters. See Environment /// Manifest (env.yaml) for details. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String GroupName { get; set; } #endregion #region Parameter Tier_Name /// /// /// The name of this environment tier.Valid values: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Tier_Name { get; set; } #endregion #region Parameter OptionSetting /// /// /// If specified, AWS Elastic Beanstalk updates the configuration set associated with /// the running environment and sets the specified configuration options to the requested /// value. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("OptionSettings")] public Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting[] OptionSetting { get; set; } #endregion #region Parameter OptionsToRemove /// /// /// A list of custom user-defined configuration options to remove from the configuration /// set for this environment. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public Amazon.ElasticBeanstalk.Model.OptionSpecification[] OptionsToRemove { get; set; } #endregion #region Parameter PlatformArn /// /// /// The ARN of the platform, if used. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PlatformArn { get; set; } #endregion #region Parameter SolutionStackName /// /// /// This specifies the platform version that the environment will run after the environment /// is updated. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SolutionStackName { get; set; } #endregion #region Parameter TemplateName /// /// /// If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template /// to the environment. If no such configuration template is found, AWS Elastic Beanstalk /// returns an InvalidParameterValue error. /// /// [System.Management.Automation.Parameter(Position = 3, ValueFromPipelineByPropertyName = true)] public System.String TemplateName { get; set; } #endregion #region Parameter Tier_Type /// /// /// The type of this environment tier.Valid values: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Tier_Type { get; set; } #endregion #region Parameter Tier_Version /// /// /// The version of this environment tier. When you don't set a value to it, Elastic Beanstalk /// uses the latest compatible worker tier version.This member is deprecated. Any specific version that you set may become out of date. /// We recommend leaving it unspecified. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Tier_Version { get; set; } #endregion #region Parameter VersionLabel /// /// /// If this parameter is specified, AWS Elastic Beanstalk deploys the named application /// version to the environment. If no such application version is found, returns an InvalidParameterValue /// error. /// /// [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)] public System.String VersionLabel { 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.ElasticBeanstalk.Model.UpdateEnvironmentResponse). /// Specifying the name of a property of type Amazon.ElasticBeanstalk.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; } = "*"; #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-EBEnvironment (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.ApplicationName = this.ApplicationName; context.Description = this.Description; context.EnvironmentId = this.EnvironmentId; context.EnvironmentName = this.EnvironmentName; context.GroupName = this.GroupName; if (this.OptionSetting != null) { context.OptionSetting = new List(this.OptionSetting); } if (this.OptionsToRemove != null) { context.OptionsToRemove = new List(this.OptionsToRemove); } context.PlatformArn = this.PlatformArn; context.SolutionStackName = this.SolutionStackName; context.TemplateName = this.TemplateName; context.Tier_Name = this.Tier_Name; context.Tier_Type = this.Tier_Type; context.Tier_Version = this.Tier_Version; context.VersionLabel = this.VersionLabel; // 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.ElasticBeanstalk.Model.UpdateEnvironmentRequest(); if (cmdletContext.ApplicationName != null) { request.ApplicationName = cmdletContext.ApplicationName; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.EnvironmentId != null) { request.EnvironmentId = cmdletContext.EnvironmentId; } if (cmdletContext.EnvironmentName != null) { request.EnvironmentName = cmdletContext.EnvironmentName; } if (cmdletContext.GroupName != null) { request.GroupName = cmdletContext.GroupName; } if (cmdletContext.OptionSetting != null) { request.OptionSettings = cmdletContext.OptionSetting; } if (cmdletContext.OptionsToRemove != null) { request.OptionsToRemove = cmdletContext.OptionsToRemove; } if (cmdletContext.PlatformArn != null) { request.PlatformArn = cmdletContext.PlatformArn; } if (cmdletContext.SolutionStackName != null) { request.SolutionStackName = cmdletContext.SolutionStackName; } if (cmdletContext.TemplateName != null) { request.TemplateName = cmdletContext.TemplateName; } // populate Tier var requestTierIsNull = true; request.Tier = new Amazon.ElasticBeanstalk.Model.EnvironmentTier(); System.String requestTier_tier_Name = null; if (cmdletContext.Tier_Name != null) { requestTier_tier_Name = cmdletContext.Tier_Name; } if (requestTier_tier_Name != null) { request.Tier.Name = requestTier_tier_Name; requestTierIsNull = false; } System.String requestTier_tier_Type = null; if (cmdletContext.Tier_Type != null) { requestTier_tier_Type = cmdletContext.Tier_Type; } if (requestTier_tier_Type != null) { request.Tier.Type = requestTier_tier_Type; requestTierIsNull = false; } System.String requestTier_tier_Version = null; if (cmdletContext.Tier_Version != null) { requestTier_tier_Version = cmdletContext.Tier_Version; } if (requestTier_tier_Version != null) { request.Tier.Version = requestTier_tier_Version; requestTierIsNull = false; } // determine if request.Tier should be set to null if (requestTierIsNull) { request.Tier = null; } if (cmdletContext.VersionLabel != null) { request.VersionLabel = cmdletContext.VersionLabel; } 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.ElasticBeanstalk.Model.UpdateEnvironmentResponse CallAWSServiceOperation(IAmazonElasticBeanstalk client, Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Elastic Beanstalk", "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.String ApplicationName { get; set; } public System.String Description { get; set; } public System.String EnvironmentId { get; set; } public System.String EnvironmentName { get; set; } public System.String GroupName { get; set; } public List OptionSetting { get; set; } public List OptionsToRemove { get; set; } public System.String PlatformArn { get; set; } public System.String SolutionStackName { get; set; } public System.String TemplateName { get; set; } public System.String Tier_Name { get; set; } public System.String Tier_Type { get; set; } public System.String Tier_Version { get; set; } public System.String VersionLabel { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }