/******************************************************************************* * 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 information about the overall health of the specified environment. The DescribeEnvironmentHealth /// operation is only available with AWS Elastic Beanstalk Enhanced Health. /// [Cmdlet("Get", "EBEnvironmentHealth")] [OutputType("Amazon.ElasticBeanstalk.Model.DescribeEnvironmentHealthResponse")] [AWSCmdlet("Calls the AWS Elastic Beanstalk DescribeEnvironmentHealth API operation.", Operation = new[] {"DescribeEnvironmentHealth"}, SelectReturnType = typeof(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentHealthResponse))] [AWSCmdletOutput("Amazon.ElasticBeanstalk.Model.DescribeEnvironmentHealthResponse", "This cmdlet returns an Amazon.ElasticBeanstalk.Model.DescribeEnvironmentHealthResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetEBEnvironmentHealthCmdlet : AmazonElasticBeanstalkClientCmdlet, IExecutor { #region Parameter AttributeName /// /// /// Specify the response elements to return. To retrieve all attributes, set to All. /// If no attribute names are specified, returns the name of the environment. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("AttributeNames")] public System.String[] AttributeName { get; set; } #endregion #region Parameter EnvironmentId /// /// /// Specify the environment by ID.You must specify either this or an EnvironmentName, or both. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String EnvironmentId { get; set; } #endregion #region Parameter EnvironmentName /// /// /// Specify the environment by name.You must specify either this or an EnvironmentName, or both. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String EnvironmentName { 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.DescribeEnvironmentHealthResponse). /// Specifying the name of a property of type Amazon.ElasticBeanstalk.Model.DescribeEnvironmentHealthResponse 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 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.EnvironmentId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.AttributeName != null) { context.AttributeName = new List(this.AttributeName); } context.EnvironmentId = this.EnvironmentId; context.EnvironmentName = this.EnvironmentName; // 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.DescribeEnvironmentHealthRequest(); if (cmdletContext.AttributeName != null) { request.AttributeNames = cmdletContext.AttributeName; } if (cmdletContext.EnvironmentId != null) { request.EnvironmentId = cmdletContext.EnvironmentId; } if (cmdletContext.EnvironmentName != null) { request.EnvironmentName = cmdletContext.EnvironmentName; } 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.DescribeEnvironmentHealthResponse CallAWSServiceOperation(IAmazonElasticBeanstalk client, Amazon.ElasticBeanstalk.Model.DescribeEnvironmentHealthRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Elastic Beanstalk", "DescribeEnvironmentHealth"); try { #if DESKTOP return client.DescribeEnvironmentHealth(request); #elif CORECLR return client.DescribeEnvironmentHealthAsync(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 List AttributeName { get; set; } public System.String EnvironmentId { get; set; } public System.String EnvironmentName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }