/*******************************************************************************
* 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
{
///
/// Updates capacity settings for a fleet. For fleets with multiple locations, use this
/// operation to manage capacity settings in each location individually. Fleet capacity
/// determines the number of game sessions and players that can be hosted based on the
/// fleet configuration. Use this operation to set the following fleet capacity properties:
///
///
/// -
/// Minimum/maximum size: Set hard limits on fleet capacity. Amazon GameLift cannot set
/// the fleet's capacity to a value outside of this range, whether the capacity is changed
/// manually or through automatic scaling.
///
-
/// Desired capacity: Manually set the number of Amazon EC2 instances to be maintained
/// in a fleet location. Before changing a fleet's desired capacity, you may want to call
/// DescribeEC2InstanceLimits
/// to get the maximum capacity of the fleet's Amazon EC2 instance type. Alternatively,
/// consider using automatic scaling to adjust capacity based on player demand.
///
/// This operation can be used in the following ways:
/// -
/// To update capacity for a fleet's home Region, or if the fleet has no remote locations,
/// omit the
Location
parameter. The fleet must be in ACTIVE
/// status.
/// -
/// To update capacity for a fleet's remote location, include the
Location
/// parameter set to the location to be updated. The location must be in ACTIVE
/// status.
///
/// If successful, capacity settings are updated immediately. In response a change in
/// desired capacity, Amazon GameLift initiates steps to start new instances or terminate
/// existing instances in the requested fleet location. This continues until the location's
/// active instance count matches the new desired instance count. You can track a fleet's
/// current capacity by calling DescribeFleetCapacity
/// or DescribeFleetLocationCapacity.
/// If the requested desired instance count is higher than the instance type's limit,
/// the LimitExceeded
exception occurs.
/// Learn moreScaling
/// fleet capacity
///
[Cmdlet("Update", "GMLFleetCapacity", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the Amazon GameLift Service UpdateFleetCapacity API operation.", Operation = new[] {"UpdateFleetCapacity"}, SelectReturnType = typeof(Amazon.GameLift.Model.UpdateFleetCapacityResponse))]
[AWSCmdletOutput("System.String or Amazon.GameLift.Model.UpdateFleetCapacityResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.GameLift.Model.UpdateFleetCapacityResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateGMLFleetCapacityCmdlet : AmazonGameLiftClientCmdlet, IExecutor
{
#region Parameter DesiredInstance
///
///
/// The number of Amazon EC2 instances you want to maintain in the specified fleet location.
/// This value must fall between the minimum and maximum size limits.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("DesiredInstances")]
public System.Int32? DesiredInstance { get; set; }
#endregion
#region Parameter FleetId
///
///
/// A unique identifier for the fleet to update capacity settings for. You can use either
/// the fleet ID or ARN value.
///
///
#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 FleetId { get; set; }
#endregion
#region Parameter Location
///
///
/// The name of a remote location to update fleet capacity settings 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 MaxSize
///
///
/// The maximum number of instances that are allowed in the specified fleet location.
/// If this parameter is not set, the default is 1.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? MaxSize { get; set; }
#endregion
#region Parameter MinSize
///
///
/// The minimum number of instances that are allowed in the specified fleet location.
/// If this parameter is not set, the default is 0.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? MinSize { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'FleetId'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateFleetCapacityResponse).
/// Specifying the name of a property of type Amazon.GameLift.Model.UpdateFleetCapacityResponse 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; } = "FleetId";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the FleetId parameter.
/// The -PassThru parameter is deprecated, use -Select '^FleetId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^FleetId' 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.FleetId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-GMLFleetCapacity (UpdateFleetCapacity)"))
{
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.FleetId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.DesiredInstance = this.DesiredInstance;
context.FleetId = this.FleetId;
#if MODULAR
if (this.FleetId == null && ParameterWasBound(nameof(this.FleetId)))
{
WriteWarning("You are passing $null as a value for parameter FleetId 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.Location = this.Location;
context.MaxSize = this.MaxSize;
context.MinSize = this.MinSize;
// 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.UpdateFleetCapacityRequest();
if (cmdletContext.DesiredInstance != null)
{
request.DesiredInstances = cmdletContext.DesiredInstance.Value;
}
if (cmdletContext.FleetId != null)
{
request.FleetId = cmdletContext.FleetId;
}
if (cmdletContext.Location != null)
{
request.Location = cmdletContext.Location;
}
if (cmdletContext.MaxSize != null)
{
request.MaxSize = cmdletContext.MaxSize.Value;
}
if (cmdletContext.MinSize != null)
{
request.MinSize = cmdletContext.MinSize.Value;
}
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.UpdateFleetCapacityResponse CallAWSServiceOperation(IAmazonGameLift client, Amazon.GameLift.Model.UpdateFleetCapacityRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon GameLift Service", "UpdateFleetCapacity");
try
{
#if DESKTOP
return client.UpdateFleetCapacity(request);
#elif CORECLR
return client.UpdateFleetCapacityAsync(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.Int32? DesiredInstance { get; set; }
public System.String FleetId { get; set; }
public System.String Location { get; set; }
public System.Int32? MaxSize { get; set; }
public System.Int32? MinSize { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.FleetId;
}
}
}