aws_gamelift_game_session_queue

account_id

Type: STRING

custom_event_data

Type: STRING
Provider name: CustomEventData
Description: Information that is added to all events that are related to this game session queue.

destinations

Type: UNORDERED_LIST_STRUCT
Provider name: Destinations
Description: A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

• destination_arn
  Type: STRING
  Provider name: DestinationArn
  Description: The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
  

filter_configuration

Type: STRUCT
Provider name: FilterConfiguration
Description: A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.

• allowed_locations
  Type: UNORDERED_LIST_STRING
  Provider name: AllowedLocations
  Description: A list of locations to allow game session placement in, in the form of Amazon Web Services Region codes such as us-west-2.
  

game_session_queue_arn

Type: STRING
Provider name: GameSessionQueueArn
Description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a Amazon GameLift Servers game session queue ARN, the resource ID matches the Name value.

name

Type: STRING
Provider name: Name
Description: A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

notification_target

Type: STRING
Provider name: NotificationTarget
Description: An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

player_latency_policies

Type: UNORDERED_LIST_STRUCT
Provider name: PlayerLatencyPolicies
Description: A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can’t make a placement. Policies are evaluated in order starting with the lowest maximum latency value.

• maximum_individual_player_latency_milliseconds
  Type: INT32
  Provider name: MaximumIndividualPlayerLatencyMilliseconds
  Description: The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
  
• policy_duration_seconds
  Type: INT32
  Provider name: PolicyDurationSeconds
  Description: The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.
  

priority_configuration

Type: STRUCT
Provider name: PriorityConfiguration
Description: Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

• location_order
  Type: UNORDERED_LIST_STRING
  Provider name: LocationOrder
  Description: The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations can include Amazon Web Services Region codes (such as us-west-2), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift Servers service locations.
  
• priority_order
  Type: UNORDERED_LIST_STRING
  Provider name: PriorityOrder
  Description: A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.
  • LATENCY – Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.
  • COST – Amazon GameLift Servers prioritizes queue destinations with the lowest current hosting costs. Cost is evaluated based on the destination’s location, instance type, and fleet type (Spot or On-Demand).
  • DESTINATION – Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration.
  • LOCATION – Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in LocationOrder.

tags

Type: UNORDERED_LIST_STRING

timeout_in_seconds

Type: INT32
Provider name: TimeoutInSeconds
Description: The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.