Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . gamelift ]

describe-fleet-port-settings

Description

Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.

Learn more

Working with Fleets .

Related operations

  • CreateFleet
  • ListFleets
  • DeleteFleet
  • Describe fleets:
    • DescribeFleetAttributes
    • DescribeFleetCapacity
    • DescribeFleetPortSettings
    • DescribeFleetUtilization
    • DescribeRuntimeConfiguration
    • DescribeEC2InstanceLimits
    • DescribeFleetEvents
  • Update fleets:
    • UpdateFleetAttributes
    • UpdateFleetCapacity
    • UpdateFleetPortSettings
    • UpdateRuntimeConfiguration
  • Manage fleet actions:
    • StartFleetActions
    • StopFleetActions

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-fleet-port-settings
--fleet-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--fleet-id (string)

Unique identifier for a fleet to retrieve port settings for.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

InboundPermissions -> (list)

Object that contains port settings for the requested fleet ID.

(structure)

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP for use by the Realtime servers.

FromPort -> (integer)

Starting value for a range of allowed port numbers.

ToPort -> (integer)

Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort .

IpRange -> (string)

Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask] " or optionally the shortened version "0.0.0.0/[subnet mask] ".

Protocol -> (string)

Network communication protocol used by the fleet.