/******************************************************************************* * 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 { /// /// This operation is used with the Amazon GameLift FleetIQ solution and game server /// groups. /// Updates information about a registered game server to help Amazon GameLift FleetIQ /// to track game server availability. This operation is called by a game server process /// that is running on an instance in a game server group. /// /// Use this operation to update the following types of game server information. You can /// make all three types of updates in the same request: /// /// Once a game server is successfully updated, the relevant statuses and timestamps are /// updated. /// Learn moreAmazon /// GameLift FleetIQ Guide /// [Cmdlet("Update", "GMLGameServer", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.GameLift.Model.GameServer")] [AWSCmdlet("Calls the Amazon GameLift Service UpdateGameServer API operation.", Operation = new[] {"UpdateGameServer"}, SelectReturnType = typeof(Amazon.GameLift.Model.UpdateGameServerResponse))] [AWSCmdletOutput("Amazon.GameLift.Model.GameServer or Amazon.GameLift.Model.UpdateGameServerResponse", "This cmdlet returns an Amazon.GameLift.Model.GameServer object.", "The service call response (type Amazon.GameLift.Model.UpdateGameServerResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateGMLGameServerCmdlet : AmazonGameLiftClientCmdlet, IExecutor { #region Parameter GameServerData /// /// /// A set of custom game server properties, formatted as a single string value. This data /// is passed to a game client or service when it requests information on game servers. /// /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String GameServerData { get; set; } #endregion #region Parameter GameServerGroupName /// /// /// A unique identifier for the game server group where the game server is running. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String GameServerGroupName { get; set; } #endregion #region Parameter GameServerId /// /// /// A custom string that uniquely identifies the game server to update. /// /// #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 GameServerId { get; set; } #endregion #region Parameter HealthCheck /// /// /// Indicates health status of the game server. A request that includes this parameter /// updates the game server's LastHealthCheckTime timestamp. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.GameLift.GameServerHealthCheck")] public Amazon.GameLift.GameServerHealthCheck HealthCheck { get; set; } #endregion #region Parameter UtilizationStatus /// /// /// Indicates whether the game server is available or is currently hosting gameplay. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.GameLift.GameServerUtilizationStatus")] public Amazon.GameLift.GameServerUtilizationStatus UtilizationStatus { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'GameServer'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.UpdateGameServerResponse). /// Specifying the name of a property of type Amazon.GameLift.Model.UpdateGameServerResponse 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; } = "GameServer"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the GameServerId parameter. /// The -PassThru parameter is deprecated, use -Select '^GameServerId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^GameServerId' 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.GameServerId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-GMLGameServer (UpdateGameServer)")) { 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.GameServerId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.GameServerData = this.GameServerData; context.GameServerGroupName = this.GameServerGroupName; #if MODULAR if (this.GameServerGroupName == null && ParameterWasBound(nameof(this.GameServerGroupName))) { WriteWarning("You are passing $null as a value for parameter GameServerGroupName 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.GameServerId = this.GameServerId; #if MODULAR if (this.GameServerId == null && ParameterWasBound(nameof(this.GameServerId))) { WriteWarning("You are passing $null as a value for parameter GameServerId 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.HealthCheck = this.HealthCheck; context.UtilizationStatus = this.UtilizationStatus; // 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.UpdateGameServerRequest(); if (cmdletContext.GameServerData != null) { request.GameServerData = cmdletContext.GameServerData; } if (cmdletContext.GameServerGroupName != null) { request.GameServerGroupName = cmdletContext.GameServerGroupName; } if (cmdletContext.GameServerId != null) { request.GameServerId = cmdletContext.GameServerId; } if (cmdletContext.HealthCheck != null) { request.HealthCheck = cmdletContext.HealthCheck; } if (cmdletContext.UtilizationStatus != null) { request.UtilizationStatus = cmdletContext.UtilizationStatus; } 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.UpdateGameServerResponse CallAWSServiceOperation(IAmazonGameLift client, Amazon.GameLift.Model.UpdateGameServerRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon GameLift Service", "UpdateGameServer"); try { #if DESKTOP return client.UpdateGameServer(request); #elif CORECLR return client.UpdateGameServerAsync(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 GameServerData { get; set; } public System.String GameServerGroupName { get; set; } public System.String GameServerId { get; set; } public Amazon.GameLift.GameServerHealthCheck HealthCheck { get; set; } public Amazon.GameLift.GameServerUtilizationStatus UtilizationStatus { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.GameServer; } } }