[ aws . gamelift ]

describe-fleet-port-settings

Description

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 use connections that fall in this range.

To get a fleet’s inbound connection permissions, specify the fleet’s unique identifier. 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

Setting up GameLift Fleets

Related operations

• CreateFleet

• ListFleets

• DeleteFleet

• Describe fleets:

  • DescribeFleetAttributes

  • DescribeFleetCapacity

  • DescribeFleetPortSettings

  • DescribeFleetUtilization

  • DescribeRuntimeConfiguration

  • DescribeEC2InstanceLimits

  • DescribeFleetEvents

• UpdateFleetAttributes

• StartFleetActions or 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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--fleet-id (string)

A unique identifier for a fleet to retrieve port settings for. You can use either the fleet ID or ARN value.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To view inbound connection permissions for a fleet

The following describe-fleet-port-settings example retrieves connection settings for a specified fleet.

aws gamelift describe-fleet-port-settings \
    --fleet-id arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Output:

{
    "InboundPermissions": [
        {
            "FromPort": 33400,
            "ToPort": 33500,
            "IpRange": "0.0.0.0/0",
            "Protocol": "UDP"
        },
        {
            "FromPort": 1900,
            "ToPort": 2000,
            "IpRange": "0.0.0.0/0",
            "Protocol": "TCP"
        }
    ]
}

For more information, see Setting Up GameLift Fleets in the Amazon GameLift Developer Guide.

Output

InboundPermissions -> (list)

The 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 hosting resource. 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)

A starting value for a range of allowed port numbers.

ToPort -> (integer)

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

IpRange -> (string)

A 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)

The network communication protocol used by the fleet.