fleet_port_settings
Creates, updates, deletes, gets or lists a fleet_port_settings resource.
Overview
| Name | fleet_port_settings |
| Type | Resource |
| Id | aws.gamelift.fleet_port_settings |
Fields
The following fields are returned by SELECT queries:
- describe_fleet_port_settings
| Name | Datatype | Description |
|---|---|---|
fleet_arn | string | The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. (pattern: <code>^arn:.*:[a-z]*fleet/[a-z]*fleet-[a-zA-Z0-9-]+$</code>) |
fleet_id | string | A unique identifier for the fleet that was requested. (pattern: <code>^[a-z]*fleet-[a-zA-Z0-9-]+$</code>) |
inbound_permissions | array | The port settings for the requested fleet ID. |
location | string | The requested fleet location, expressed as an Amazon Web Services Region code, such as us-west-2. (pattern: <code>^[A-Za-z0-9-]+$</code>) |
update_status | string | The current status of updates to the fleet's port settings in the requested fleet location. A status of PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location. (PENDING_UPDATE) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_fleet_port_settings | select | region | This API works with the following fleet types: EC2 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. 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 Servers fleets | |
update_fleet_port_settings | update | region, FleetId | This API works with the following fleet types: EC2 Updates permissions that allow inbound traffic to connect to game sessions in the fleet. To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet identifiers for the updated fleet are returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling DescribeFleetPortSettings with a location name. Learn more Setting up Amazon GameLift Servers fleets |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_fleet_port_settings
This API works with the following fleet types: EC2 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. 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 Servers fleets
SELECT
fleet_arn,
fleet_id,
inbound_permissions,
location,
update_status
FROM aws.gamelift.fleet_port_settings
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_fleet_port_settings
This API works with the following fleet types: EC2 Updates permissions that allow inbound traffic to connect to game sessions in the fleet. To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet identifiers for the updated fleet are returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling DescribeFleetPortSettings with a location name. Learn more Setting up Amazon GameLift Servers fleets
UPDATE aws.gamelift.fleet_port_settings
SET
FleetId = '{{ FleetId }}',
InboundPermissionAuthorizations = '{{ InboundPermissionAuthorizations }}',
InboundPermissionRevocations = '{{ InboundPermissionRevocations }}'
WHERE
region = '{{ region }}' --required
AND FleetId = '{{ FleetId }}' --required
RETURNING
fleet_arn,
fleet_id;