/******************************************************************************* * 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 { /// /// Returns a description of the settings for the specified configuration set, that is, /// either a configuration template or the configuration set associated with a running /// environment. /// /// /// /// When describing the settings for the configuration set associated with a running environment, /// it is possible to receive two sets of setting descriptions. One is the deployed configuration /// set, and the other is a draft configuration of an environment that is either in the /// process of deployment or that failed to deploy. /// /// Related Topics /// /// [Cmdlet("Get", "EBConfigurationSetting")] [OutputType("Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription")] [AWSCmdlet("Calls the AWS Elastic Beanstalk DescribeConfigurationSettings API operation.", Operation = new[] {"DescribeConfigurationSettings"}, SelectReturnType = typeof(Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsResponse), LegacyAlias="Get-EBConfigurationSettings")] [AWSCmdletOutput("Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription or Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsResponse", "This cmdlet returns a collection of Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription objects.", "The service call response (type Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetEBConfigurationSettingCmdlet : AmazonElasticBeanstalkClientCmdlet, IExecutor { #region Parameter ApplicationName /// /// /// The application for the environment or configuration template. /// /// #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 EnvironmentName /// /// /// The name of the environment to describe. Condition: You must specify either this or a TemplateName, but not both. If you specify /// both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. /// If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter /// error. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String EnvironmentName { get; set; } #endregion #region Parameter TemplateName /// /// /// The name of the configuration template to describe. Conditional: You must specify either this parameter or an EnvironmentName, but not /// both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination /// error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter /// error. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String TemplateName { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'ConfigurationSettings'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsResponse). /// Specifying the name of a property of type Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsResponse 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; } = "ConfigurationSettings"; #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.EnvironmentName = this.EnvironmentName; context.TemplateName = this.TemplateName; // 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.DescribeConfigurationSettingsRequest(); if (cmdletContext.ApplicationName != null) { request.ApplicationName = cmdletContext.ApplicationName; } if (cmdletContext.EnvironmentName != null) { request.EnvironmentName = cmdletContext.EnvironmentName; } if (cmdletContext.TemplateName != null) { request.TemplateName = cmdletContext.TemplateName; } 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.DescribeConfigurationSettingsResponse CallAWSServiceOperation(IAmazonElasticBeanstalk client, Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Elastic Beanstalk", "DescribeConfigurationSettings"); try { #if DESKTOP return client.DescribeConfigurationSettings(request); #elif CORECLR return client.DescribeConfigurationSettingsAsync(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 EnvironmentName { get; set; } public System.String TemplateName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.ConfigurationSettings; } } }