/*******************************************************************************
* 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
{
/// <summary>
/// Retrieves a fleet's inbound connection permissions. Connection permissions specify
/// the range of IP addresses and port settings that incoming traffic can use to access
/// server processes in the fleet. Game sessions that are running on instances in the
/// fleet must use connections that fall in this range.
///
///
/// <para>
/// This operation can be used in the following ways:
/// </para><ul><li><para>
/// To retrieve the inbound connection permissions for a fleet, identify the fleet's unique
/// identifier.
/// </para></li><li><para>
/// To check the status of recent updates to a fleet remote location, specify the fleet
/// ID and a location. Port setting updates can take time to propagate across all locations.
///
/// </para></li></ul><para>
/// If successful, a set of <code>IpPermission</code> objects is returned for the requested
/// fleet ID. When a location is specified, a pending status is included. If the requested
/// fleet has been deleted, the result set is empty.
/// </para><para><b>Learn more</b></para><para><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting
/// up Amazon GameLift fleets</a></para>
/// </summary>
[Cmdlet("Get", "GMLFleetPortSetting")]
[OutputType("Amazon.GameLift.Model.IpPermission")]
[AWSCmdlet("Calls the Amazon GameLift Service DescribeFleetPortSettings API operation.", Operation = new[] {"DescribeFleetPortSettings"}, SelectReturnType = typeof(Amazon.GameLift.Model.DescribeFleetPortSettingsResponse))]
[AWSCmdletOutput("Amazon.GameLift.Model.IpPermission or Amazon.GameLift.Model.DescribeFleetPortSettingsResponse",
"This cmdlet returns a collection of Amazon.GameLift.Model.IpPermission objects.",
"The service call response (type Amazon.GameLift.Model.DescribeFleetPortSettingsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetGMLFleetPortSettingCmdlet : AmazonGameLiftClientCmdlet, IExecutor
{
#region Parameter FleetId
/// <summary>
/// <para>
/// <para>A unique identifier for the fleet to retrieve port settings for. You can use either
/// the fleet ID or ARN value.</para>
/// </para>
/// </summary>
#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
/// <summary>
/// <para>
/// <para>A remote location to check for status of port setting updates. Use the Amazon Web
/// Services Region code format, such as <code>us-west-2</code>.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Location { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// Use the -Select parameter to control the cmdlet output. The default value is 'InboundPermissions'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GameLift.Model.DescribeFleetPortSettingsResponse).
/// Specifying the name of a property of type Amazon.GameLift.Model.DescribeFleetPortSettingsResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "InboundPermissions";
#endregion
#region Parameter PassThru
/// <summary>
/// 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.
/// </summary>
[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
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<Amazon.GameLift.Model.DescribeFleetPortSettingsResponse, GetGMLFleetPortSettingCmdlet>(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.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;
// 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.DescribeFleetPortSettingsRequest();
if (cmdletContext.FleetId != null)
{
request.FleetId = cmdletContext.FleetId;
}
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.DescribeFleetPortSettingsResponse CallAWSServiceOperation(IAmazonGameLift client, Amazon.GameLift.Model.DescribeFleetPortSettingsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon GameLift Service", "DescribeFleetPortSettings");
try
{
#if DESKTOP
return client.DescribeFleetPortSettings(request);
#elif CORECLR
return client.DescribeFleetPortSettingsAsync(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 FleetId { get; set; }
public System.String Location { get; set; }
public System.Func<Amazon.GameLift.Model.DescribeFleetPortSettingsResponse, GetGMLFleetPortSettingCmdlet, object> Select { get; set; } =
(response, cmdlet) => response.InboundPermissions;
}
}
}