/******************************************************************************* * 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.GameLift; using Amazon.GameLift.Model; namespace Amazon.PowerShell.Cmdlets.GML { /// /// Retrieves the instance limits and current utilization for an Amazon Web Services Region /// or location. Instance limits control the number of instances, per instance type, per /// location, that your Amazon Web Services account can use. Learn more at Amazon /// EC2 Instance Types. The information returned includes the maximum number of instances /// allowed and your account's current usage across all fleets. This information can affect /// your ability to scale your Amazon GameLift fleets. You can request a limit increase /// for your account by using the Service limits page in the Amazon GameLift console. /// /// /// /// Instance limits differ based on whether the instances are deployed in a fleet's home /// Region or in a remote location. For remote locations, limits also differ based on /// the combination of home Region and remote location. All requests must specify an Amazon /// Web Services Region (either explicitly or as your default settings). To get the limit /// for a remote location, you must also specify the location. For example, the following /// requests all return different results: /// /// This operation can be used in the following ways: /// /// If successful, an EC2InstanceLimits object is returned with limits and /// usage data for each requested instance type. /// Learn moreSetting /// up Amazon GameLift fleets /// [Cmdlet("Get", "GMLEC2InstanceLimit")] [OutputType("Amazon.GameLift.Model.EC2InstanceLimit")] [AWSCmdlet("Calls the Amazon GameLift Service DescribeEC2InstanceLimits API operation.", Operation = new[] {"DescribeEC2InstanceLimits"}, SelectReturnType = typeof(Amazon.GameLift.Model.DescribeEC2InstanceLimitsResponse))] [AWSCmdletOutput("Amazon.GameLift.Model.EC2InstanceLimit or Amazon.GameLift.Model.DescribeEC2InstanceLimitsResponse", "This cmdlet returns a collection of Amazon.GameLift.Model.EC2InstanceLimit objects.", "The service call response (type Amazon.GameLift.Model.DescribeEC2InstanceLimitsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetGMLEC2InstanceLimitCmdlet : AmazonGameLiftClientCmdlet, IExecutor { #region Parameter EC2InstanceType /// /// /// Name of an Amazon EC2 instance type that is supported in Amazon GameLift. A fleet /// instance type determines the computing resources of each instance in the fleet, including /// CPU, memory, storage, and networking capacity. Do not specify a value for this parameter /// to retrieve limits for all instance types. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] [AWSConstantClassSource("Amazon.GameLift.EC2InstanceType")] public Amazon.GameLift.EC2InstanceType EC2InstanceType { get; set; } #endregion #region Parameter Location /// /// /// The name of a remote location to request instance limits for, in the form of an Amazon /// Web Services Region code such as us-west-2. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Location { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'EC2InstanceLimits'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeEC2InstanceLimitsResponse). /// Specifying the name of a property of type Amazon.GameLift.Model.DescribeEC2InstanceLimitsResponse 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; } = "EC2InstanceLimits"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the EC2InstanceType parameter. /// The -PassThru parameter is deprecated, use -Select '^EC2InstanceType' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^EC2InstanceType' 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.EC2InstanceType; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.EC2InstanceType = this.EC2InstanceType; context.Location = this.Location; // 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.GameLift.Model.DescribeEC2InstanceLimitsRequest(); if (cmdletContext.EC2InstanceType != null) { request.EC2InstanceType = cmdletContext.EC2InstanceType; } if (cmdletContext.Location != null) { request.Location = cmdletContext.Location; } 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.GameLift.Model.DescribeEC2InstanceLimitsResponse CallAWSServiceOperation(IAmazonGameLift client, Amazon.GameLift.Model.DescribeEC2InstanceLimitsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon GameLift Service", "DescribeEC2InstanceLimits"); try { #if DESKTOP return client.DescribeEC2InstanceLimits(request); #elif CORECLR return client.DescribeEC2InstanceLimitsAsync(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 Amazon.GameLift.EC2InstanceType EC2InstanceType { get; set; } public System.String Location { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.EC2InstanceLimits; } } }