/AWS1/CL_GML=>DESCRIBEFLEETPORTSETTINGS()¶
About DescribeFleetPortSettings¶
Retrieves a fleet's inbound connection permissions. Connection permissions specify IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game server processes that are running in the fleet must use a port that falls within this range. To connect to game server processes on a container fleet, the port settings should include one or more of the fleet's connection ports.
Use this operation in the following ways:
-
To retrieve the port settings for a fleet, identify the fleet's unique identifier.
-
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.
If successful, a set of IpPermission objects is returned for the
requested fleet ID. When specifying a location, this operation returns a pending status.
If the requested fleet has been deleted, the result set is empty.
Learn more
Setting up Amazon GameLift fleets
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_FLEETID TYPE /AWS1/GMLFLEETIDORARN /AWS1/GMLFLEETIDORARN¶
A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value.
Optional arguments:¶
IV_LOCATION TYPE /AWS1/GMLLOCATIONSTRINGMODEL /AWS1/GMLLOCATIONSTRINGMODEL¶
A remote location to check for status of port setting updates. Use the Amazon Web Services Region code format, such as
us-west-2.